Skip to content

Documentation setup

Robert Eckelmann requested to merge longnoserob/pmbootstrap:docs into master

Introduces a setup for creating documentation with sphinx and sphinx-rtd-theme via CI runner

Closes #2315, #2308

Example HTML-output can be seen here updated 2024-03-02 04:17h UTC

ToDo:

  • theme is currently the rtd default theme, could be modified for pmos (could also be done later)
  • CI runner will need modification for publishing the html docs of the master branch
  • docstrings of about 500 elements in pmb would need to be written
  • usage section is very very basic at the moment
  • links to wiki could be added e.g. troubleshooting
Edited by Robert Eckelmann

Merge request reports