devilbox/docs
2018-12-29 15:25:41 +01:00
..
_includes Update readthedocs for phpPgAdmin 2018-12-28 22:44:50 +01:00
_static/css Clean-up unused files 2018-07-26 09:39:00 +02:00
advanced Add documentation for custom startup scripts 2018-12-26 17:31:09 +01:00
configuration-files Refs #439 Adding sqlsrv and pdo_sqlsrv for PHP 7.0, 7.1, 7.2 and 7.3 2018-12-23 12:19:38 +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 Documentation: Use Magento 2 instead of Magento where applicable 2018-11-12 09:04:07 +01:00
getting-started Update readthedocs for phpPgAdmin 2018-12-28 22:44:50 +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 #250: 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 Refs #378: Add tool: Deployer 2018-09-14 08:58:16 +02:00
support Refs #105 document how to mitigate OSX performance issues 2018-11-01 10:50:10 +01: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 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 Add documentation for custom startup scripts 2018-12-26 17:31:09 +01:00
Install.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Makefile Allow linkcheck to ignore SSL certificate issues 2018-11-03 12:33:06 +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