devilbox/docs
2018-10-23 10:30:49 +07:00
..
_includes Refs : Add tool: Deployer 2018-09-14 08:58:16 +02:00
_static/css Clean-up unused files 2018-07-26 09:39:00 +02:00
advanced Adding new container: Blackfire 2018-08-19 12:27:42 +02:00
configuration-files Fixes Adding rdkafka-enabled PHP container 2018-09-27 09:48:14 +02: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 2018-10-23 10:30:49 +07:00
getting-started Add documentation for phpRedMin 2018-08-12 11:21:31 +02:00
howto Move links into separate file 2018-07-26 09:38:56 +02:00
img Fixes - Documentation: Install CraftCMS 2018-08-08 09:31:36 +02:00
intermediate MailHog fine-tuning 2018-08-15 19:53:06 +02:00
maintenance Documentation for vhost-gen templates 2018-08-06 21:42:03 +02:00
readings Refs : Add tool: Deployer 2018-09-14 08:58:16 +02:00
support Fix : Disable swoole by default 2018-08-24 09:29:42 +02:00
vhost-gen Update customize-specific-virtual-host.rst 2018-10-05 10:04:04 +02: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 Make timeout from httpd to php-fpm configurable 2018-08-05 03:04:03 +02:00
Hacking.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
index.rst Adding new container: Blackfire 2018-08-19 12:27:42 +02:00
Install.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Makefile Linkcheck: increase retries 2018-08-12 11:51:08 +02: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 Documentation restructuring 2018-07-26 09:38:35 +02: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
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