Compile the local version of the documentation¶
Do you want a local version of this wonderful documentation?
Hey, you know what? You already got it!
The documentation is present in the
docs directory, in reStructuredText format. You must compile it to HTML format in order to access it directly via the ClorSensoud web interface, without the need of any internet access.
Install pre-requisite dependencies¶
To compile the documentation, you need to install the Sphinx software on the server:
sudo apt install python3-sphinx
Compile the documentation¶
To compile the documentation, just run a command into the
cd docs && make html
When done, you can access to the local version of the documentation via a link on the ClorSensoud web interface, or directly via this URL: