mirror of
https://github.com/cytopia/devilbox.git
synced 2025-04-08 03:24:15 +00:00
d375244920
I prefer to write code than documentation and I am not native speaker so feel free to suggest or make changes. https://jira.mariadb.org/browse/MDEV-27937 Closes #870
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
- Docker
How to check for broken links
cd docs/
make linkcheck
make linkcheck2
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://0.0.0.0:8000