documentation generator Sphinx docs for Sensorgnome software and hardware for read the docs.
https://sensorgnome.readthedocs.io/
- Optionally, create a virtualenv.
- run
pip install -r requirements.txt
To build the documentation locally to test: run make html and then open the result from _build/html.
To clean the built documentation, which should be done after changes are made to preview the output, run make clean.
To test document building, run sphinx-build -nT -b dummy . _build/html, which will show all errors and warnings.
The project has been set up to use Travis CI to test the project is formatted and builds correctly. It does not do grammar or spell checking.
If you'd like to contribute to the docs, please fork this repo, make your changes and open a pull request so that we can review and then get your changes into the project.
You can also open an issue if something is unclear, to request missing documentation, etc.
Documentation is written using Restructured Text. A useful cheatsheet: https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
Uses sphinx-contrib/youtube to embed YouTube videos in sphinx output.