From d6464f0fde39665a83933b70fffd896bc5559ec8 Mon Sep 17 00:00:00 2001
From: rschoene <rene.schoene@tu-dresden.de>
Date: Thu, 14 Jan 2021 18:33:39 +0100
Subject: [PATCH] Begin with documentation.

---
 .gitlab-ci.yml       | 12 +++++++++
 pages/.gitignore     |  1 +
 pages/Makefile       | 20 +++++++++++++++
 pages/conf.py        | 59 ++++++++++++++++++++++++++++++++++++++++++++
 pages/dumpAst.md     |  3 +++
 pages/grammar2uml.md |  3 +++
 pages/index.rst      | 24 ++++++++++++++++++
 pages/make.bat       | 35 ++++++++++++++++++++++++++
 8 files changed, 157 insertions(+)
 create mode 100644 pages/.gitignore
 create mode 100644 pages/Makefile
 create mode 100644 pages/conf.py
 create mode 100644 pages/dumpAst.md
 create mode 100644 pages/grammar2uml.md
 create mode 100644 pages/index.rst
 create mode 100644 pages/make.bat

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 374a516..f212e14 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -30,3 +30,15 @@ publish:
     - "./gradlew publish"
   only:
     - master
+
+pages:
+  image: python:3.7-alpine
+  stage: publish
+  script:
+  - pip install -U sphinx sphinx-rtd-theme recommonmark sphinxemoji sphinx-markdown-tables
+  - sphinx-build -b html pages/ public
+  artifacts:
+    paths:
+    - public
+  only:
+  - master
diff --git a/pages/.gitignore b/pages/.gitignore
new file mode 100644
index 0000000..87174b6
--- /dev/null
+++ b/pages/.gitignore
@@ -0,0 +1 @@
+/public/
diff --git a/pages/Makefile b/pages/Makefile
new file mode 100644
index 0000000..7878ee5
--- /dev/null
+++ b/pages/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = public
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/pages/conf.py b/pages/conf.py
new file mode 100644
index 0000000..7483de1
--- /dev/null
+++ b/pages/conf.py
@@ -0,0 +1,59 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+import sphinx_rtd_theme
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Relast2Uml'
+copyright = '2021, René Schöne'
+author = 'René Schöne'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx_rtd_theme',
+    'recommonmark',
+    'sphinxemoji.sphinxemoji',
+    'sphinx_markdown_tables'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['public', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+sphinxemoji_style = 'twemoji'
diff --git a/pages/dumpAst.md b/pages/dumpAst.md
new file mode 100644
index 0000000..d160729
--- /dev/null
+++ b/pages/dumpAst.md
@@ -0,0 +1,3 @@
+# DumpAst
+
+The tool called [`DumpAst`](https://git-st.inf.tu-dresden.de/jastadd/relast2uml/-/tree/master/dumpAst) is used to create a snapshot of an AST and visualize it.
diff --git a/pages/grammar2uml.md b/pages/grammar2uml.md
new file mode 100644
index 0000000..2ec4cf8
--- /dev/null
+++ b/pages/grammar2uml.md
@@ -0,0 +1,3 @@
+# Grammar2Uml
+
+The tool called [`Grammar2Uml`](https://git-st.inf.tu-dresden.de/jastadd/relast2uml/-/tree/master/grammar2uml) takes a set of grammar specifications and creates a visualization similar to UML class diagrams.
diff --git a/pages/index.rst b/pages/index.rst
new file mode 100644
index 0000000..e818c63
--- /dev/null
+++ b/pages/index.rst
@@ -0,0 +1,24 @@
+.. Relast2Uml documentation master file, created by
+   sphinx-quickstart on Thu Jan 14 17:56:50 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Relast2Uml Documentation
+========================
+
+`Relast2Uml <https://git-st.inf.tu-dresden.de/jastadd/relast2uml>`_ is a collection of tools to visualize specifications and programs using models based on `Reference Attribute Grammars <http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.108.8792&rep=rep1&type=pdf>`_ and `Relation Reference Attribute Grammars <https://doi.org/10.1016/j.cola.2019.100940>`_ built with `JastAdd <http://jastadd.org/>`_.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   dumpAst.md
+   grammar2uml.md
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/pages/make.bat b/pages/make.bat
new file mode 100644
index 0000000..922152e
--- /dev/null
+++ b/pages/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
-- 
GitLab