mirror of
https://github.com/cytopia/devilbox.git
synced 2024-12-19 12:57:52 +00:00
| .. | ||
| _static | ||
| about | ||
| configuration-files | ||
| configuration-global | ||
| configuration-project | ||
| examples | ||
| getting-started | ||
| img | ||
| installation | ||
| maintenance | ||
| readings | ||
| support | ||
| tutorials | ||
| Backups.md | ||
| conf.py | ||
| Configure.md | ||
| Examples.md | ||
| FAQ.md | ||
| Hacking.md | ||
| index.rst | ||
| Install.md | ||
| OS.md | ||
| Quickstart.md | ||
| 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/
sphinx-build -a -E -j auto -n -q . _build/html/
How to build continuously
cd docs/
sphinx-autobuild . _build/html
How to view
Open you browser on http://127.0.0.1:8000