Skip to content

Feature/auto docs

Ezra Eisbrenner requested to merge feature/auto_docs into master

Implementing initial documentation using sphinx auto-documentation.

Notes:

  1. On the master branch, a GitLab artifact will be created from the runner
  2. For the documentation the CONTRIBUTING.md was created and placed into the repo-root
  3. The LICENSE file got a ReStructuredText header for integration into the documentation

Create the docs locally with

$ # pip install sphinx recommonmark sphinx_rtd_theme sphinx-autodoc-typehints
$ cd doc/
$ make clean && make html
$ firefox _build/html/index.html & # or whatever browser you prefer

Merge request reports