diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..7070637 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,30 @@ +image: python:3.7-alpine + +variables: + PIP_CACHE_DIR: "$CI_PROJECT_DIR/pip-cache" + +cache: + paths: + - "$CI_PROJECT_DIR/pip-cache" + key: "$CI_PROJECT_ID" + +test-docs: + stage: test + script: + - pip install -U sphinx + - sphinx-build -b html docs public + only: + - branches + except: + - master + +pages: + stage: deploy + script: + - pip install -U sphinx + - sphinx-build -b html docs public + artifacts: + paths: + - public + only: + - master diff --git a/docs/Design.odt b/docs/Design.odt deleted file mode 100644 index 4eb33fe..0000000 Binary files a/docs/Design.odt and /dev/null differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..909c7bd --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,55 @@ +# 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('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'pgLab User Manual' +copyright = '2021, Eelke Klein' +author = 'Eelke Klein' + +# The full version, including alpha/beta/rc tags +release = 'https://eelke.gitlab.io/pgLab/' + + +# -- 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 = [ +] + +# 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 = ['_build', '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 = 'alabaster' + +# 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'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..08e8642 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +.. GitLab Pages with Sphinx documentation master file, created by + sphinx-quickstart on Thu Jan 9 10:28:38 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +pgLab User Manual +==================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + +Fork this project +================== + +* https://eelke.gitlab.io/pgLab/ diff --git a/docs/statistics_mockup.ods b/docs/statistics_mockup.ods deleted file mode 100644 index 0ec8f09..0000000 Binary files a/docs/statistics_mockup.ods and /dev/null differ