devilbox/docs
2018-07-31 20:21:56 +02:00
..
_includes Documentation: Install PrestaShop 2018-07-31 20:21:56 +02:00
_static/css Clean-up unused files 2018-07-26 09:39:00 +02:00
advanced External links 2018-07-26 09:38:57 +02:00
configuration-files Generalize links 2018-07-26 09:39:03 +02:00
corporate-usage Documentation: External databases 2018-07-26 09:38:51 +02:00
examples Documentation: Install PrestaShop 2018-07-31 20:21:56 +02:00
getting-started Documentation: Install PrestaShop 2018-07-31 20:21:56 +02:00
howto Move links into separate file 2018-07-26 09:38:56 +02:00
img Restore README images 2018-07-27 00:41:31 +02:00
intermediate Generalize links 2018-07-26 09:39:03 +02:00
maintenance Generalize links 2018-07-26 09:39:03 +02:00
readings Documentation: more detailed examples 2018-07-30 09:32:40 +02:00
support Documentation: Install PrestaShop 2018-07-31 20:21:56 +02:00
vhost-gen ref How to properly add subdomains for the same project 2018-07-31 19:21:27 +02:00
Backups.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
conf.py Add documentation version 2018-07-26 09:38:43 +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 Validate raw links 2018-07-26 09:38:59 +02:00
Hacking.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
index.rst Documentation: Install PrestaShop 2018-07-31 20:21:56 +02:00
Install.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Makefile Documentation: more detailed examples 2018-07-30 09:32:40 +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