devilbox/docs
2019-03-09 11:22:32 +01:00
..
_includes Fix #525 Add docs for PHPMemcachedAdmin 2019-03-09 11:10:31 +01:00
_static/css Clean-up unused files 2018-07-26 09:39:00 +02:00
advanced Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
autostart Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
configuration-files Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
corporate-usage Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
custom-container Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
examples Add follow up steps for framework/cms examples 2019-03-07 17:23:41 +01:00
getting-started Fix #525 Add docs for PHPMemcachedAdmin 2019-03-09 11:10:31 +01:00
howto Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
img Add documentation: setup Contao CMS 2019-03-07 17:23:24 +01:00
intermediate Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
maintenance Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
readings Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
reverse-proxy Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
support Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
third-party Refs #527 Add third-party tool info page: devilbox-cli.sh 2019-03-09 11:22:32 +01:00
vhost-gen Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01: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 Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01: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 Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
Hacking.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
index.rst Refs #527 Add third-party tool info page: devilbox-cli.sh 2019-03-09 11:22:32 +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 Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01: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