mirror of
https://github.com/cytopia/devilbox.git
synced 2024-12-30 09:38:51 +00:00
1.0 KiB
1.0 KiB
Devilbox Documentation
The Devilbox documentation is build via sphinx and automatically updated on readthedocs by every git push.
Documentation
The documentation is available online: https://devilbox.readthedocs.io
Local setup
You can also build the documentation locally before pushing to ensure everything looks fine:
Requirements
sudo pip install sphinx sphinx-autobuild
sudo pip install sphinx_rtd_theme
How to build and error-check
cd docs/
make build
How to build continuously
cd docs/
make autobuild
How to view
When using make autobuild your documentation is served at: http://127.0.0.1:8000