devilbox/docs
2019-01-26 19:50:29 +01:00
..
_includes Fix documentation links 2019-01-26 17:18:19 +01:00
_static/css Clean-up unused files 2018-07-26 09:39:00 +02:00
advanced Add autostart and reverse proxy documentation 2018-12-31 13:14:29 +01:00
autostart Fixes Add Discourse forums 2019-01-03 17:57:35 +01:00
configuration-files Fix 2019-01-08 08:57:34 +01:00
corporate-usage Documentation: External databases 2018-07-26 09:38:51 +02:00
custom-container Adding new container: Blackfire 2018-08-19 12:27:42 +02:00
examples Fix typo setup-yii.rst 2019-01-18 14:46:42 +07:00
getting-started Add autostart and reverse proxy documentation 2018-12-31 13:14:29 +01:00
howto Move links into separate file 2018-07-26 09:38:56 +02:00
img Reflect Reverse proxy capabilities in README 2018-12-29 15:25:41 +01:00
intermediate Refs : Documentation - Fix php.ini comments from # to ; 2018-11-11 13:32:50 +01:00
maintenance Update readthedocs for phpPgAdmin 2018-12-28 22:44:50 +01:00
readings Fixes Add tool: PHP CS Fixer 2019-01-11 10:52:59 +01:00
reverse-proxy Add autostart and reverse proxy documentation 2018-12-31 13:14:29 +01:00
support Add autostart and reverse proxy documentation 2018-12-31 13:14:29 +01:00
vhost-gen typo 2019-01-05 14:20:06 +00:00
Backups.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
conf.py MailHog fine-tuning 2018-08-15 19:53:06 +02:00
Configure.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
devilbox-purpose.rst Documentation restructuring 2018-07-26 09:38:35 +02:00
Examples.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
FAQ.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
features.rst Update readthedocs for phpPgAdmin 2018-12-28 22:44:50 +01:00
Hacking.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
index.rst Fixes Add Discourse forums 2019-01-03 17:57:35 +01:00
Install.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Makefile Fix documentation links 2019-01-26 17:18:19 +01:00
OS.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Quickstart.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
read-first.rst Documentation restructuring 2018-07-26 09:38:35 +02:00
README.md Fix requirements to build documentation 2018-12-26 17:31:23 +01:00
Run.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Technical.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Update.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Usage.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00

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 recommonmark
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