Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.

Latest commit

 

History

History
12 lines (7 loc) · 564 Bytes

SPHINX-DOCUMENTATION.md

File metadata and controls

12 lines (7 loc) · 564 Bytes

To generate the documentation, you need sphinx installed (pip install sphinx). It is already added to the pipfile.

If you run make in the sphinx-documentation folder you can see the different formats sphinx can generate.

Because the code is not yet ideally structured for importing by the autodoc, we need to escape several lines. So we prepared a script for that:

To generate the documentation, run: bin/generate-docs [<format>]

If format is not given, html is the default.

The documentation will be saved in the folder sphinx-documentation/build/