Docs with Sphinx (!19) · Merge requests · ogs / OpenGeoSys Tools / ogstools

Lars Bilke requested to merge bilke/ogstools:docs into main Dec 06, 2022

Bare-bones documentation setup with Sphinx and sphinx-autodoc. Preview link is directly shown at the MR pipeline widget (see View app-button). Once merged will deploy to ogs.xyz/... .

Example page from msh2vtu: https://ogs.ogs.xyz/-/tools/ogstools/-/jobs/273935/artifacts/public/reference/ogstools.msh2vtu.html

Possible future enhancements:

Another theme?
Using Google style docstring, see napoleon-extension

Edited Jan 04, 2023 by Lars Bilke

Docs with Sphinx

Merge request reports