ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2024-12-19 04:47:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
2f8fc59dd9
devilbox/docs
History
cytopia 249b132e58
Merge pull request #832 from Ernestopheles/patch-1 
Update setup-auto-dns.rst
2022-01-23 13:35:44 +01:00
..
_includes Release v1.9.2 2021-06-04 10:32:46 +02:00
_static/css Fix CSS for code boxes 2019-03-09 12:48:30 +01: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 Fixes #707 Move Backups out of Devilbox directory 2020-11-14 11:51:33 +01:00
corporate-usage Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
custom-container Update enable-varnish.rst 2021-02-04 22:49:29 +01:00
examples Capitalize p in WordPress 2020-12-12 16:37:03 -08:00
getting-started Fixed typos 2021-06-20 05:07:19 +03:00
howto Update add-project-dns-entry-on-win.rst 2021-10-13 04:48:52 -07:00
img Add Python Flask logo 2020-03-24 09:29:22 +01:00
intermediate Update setup-auto-dns.rst 2021-08-24 17:48:52 +02:00
maintenance Update release tag on update docs 2019-04-05 16:55:58 +01:00
readings Release v1.9.2 2021-06-04 10:32:46 +02:00
reverse-proxy fix typo error in desired DNS name 2020-02-19 17:06:16 +01:00
support Add check-config.sh script for local troubleshooting 2020-11-12 14:19:49 +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 Upgrade sphinx deprecations 2021-05-19 16:05:45 +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 Documentation: Python Flask 2020-03-24 09:29:10 +01:00
Install.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Makefile Update documentation 2021-05-19 16:05: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 Typo + sentence change 2019-03-27 14:38:14 -04:00
README.md Build documentation in CI 2019-12-02 11:23:29 +01:00
requirements.txt Build documentation in CI 2019-12-02 11:23:29 +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

README.md

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

  • Docker

How to check for broken links

cd docs/
make linkcheck
make linkcheck2

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://0.0.0.0:8000