ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2024-12-23 14:42:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
51281ef5a0
devilbox/docs
History
cytopia f29d552dfa
Fixes #378 Allow to mount local ssh dir into PHP container (r/o)
2020-01-04 22:15:50 +01:00
..
_includes Fixes #615 Add tool: phpmd 2020-01-04 21:07:52 +01: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 #378 Allow to mount local ssh dir into PHP container (r/o) 2020-01-04 22:15:50 +01:00
corporate-usage Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
custom-container Make Ngrok region configurable via NGROK_REGION env var 2019-06-10 19:00:02 +02:00
examples Documentation: Setup ProcessWire 2019-04-20 11:56:14 +02:00
getting-started Fixes #618 Update Compose version to 2.3 2019-12-31 17:37:32 +01:00
howto Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
img Documentation: Setup ProcessWire 2019-04-20 11:56:14 +02:00
intermediate #506 documentation: how to connect to MySQL and other services 2019-03-23 20:28:10 +01:00
maintenance Update release tag on update docs 2019-04-05 16:55:58 +01:00
readings Fixes #615 Add tool: phpmd 2020-01-04 21:07:52 +01:00
reverse-proxy Add configurable PSA banner across all doc pages 2019-03-07 17:23:32 +01:00
support Remove obsolete links from documentation 2019-12-28 21:27:15 +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 Build documentation in CI 2019-12-02 11:23:29 +01: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: Setup ProcessWire 2019-04-20 11:56:14 +02:00
Install.md Documentation: Update legacy docs 2018-04-14 10:17:55 +02:00
Makefile Build documentation in CI 2019-12-02 11:23:29 +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 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