mirror of
https://github.com/cytopia/devilbox.git
synced 2025-01-20 03:36:47 +00:00
| .. | ||
| _includes | ||
| _static | ||
| advanced | ||
| configuration-files | ||
| examples | ||
| getting-started | ||
| howto | ||
| img | ||
| intermediate | ||
| maintenance | ||
| readings | ||
| support | ||
| Backups.md | ||
| conf.py | ||
| Configure.md | ||
| devilbox-purpose.rst | ||
| Examples.md | ||
| FAQ.md | ||
| features.rst | ||
| Hacking.md | ||
| index.rst | ||
| Install.md | ||
| Makefile | ||
| OS.md | ||
| Quickstart.md | ||
| read-first.rst | ||
| README.md | ||
| Run.md | ||
| Technical.md | ||
| Update.md | ||
| Usage.md | ||
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