This project is used for documenting CPSign using Sphinx. Pages are written in Markdown but were initially written i reStructuredText and converted, so there might be remnants that may need to updated.
You need to have Python, and install the dependencies in the requirements file.
Building the documentation should be performed from the docs
directory, where it can be achieved by running make html
. This will build the html-files and put them in the docs/build/html
subfolder. Open the index.html
file and check your changes.
The documentation is now hosted a ReadTheDocs and the build is handled using a webhook that monitors changes pushed to github. Multiple versions of the documentation should be handled by using tags and sorted by the readthedocs website.