Merge pull request #298 from cytopia/restructure-documentation
WIP: Restructuring of documentation
1
.gitignore
vendored
@ -82,7 +82,6 @@ docker-compose.override.yml
|
||||
# Ignore documentation sphinx build
|
||||
/docs/_build/
|
||||
/docs/make.bat
|
||||
/docs/Makefile
|
||||
*.rst.todo
|
||||
|
||||
# Keep folders
|
||||
|
@ -185,7 +185,9 @@ before_script:
|
||||
script:
|
||||
- if [ "${S1}" = "DOCUMENTATION" ]; then
|
||||
cd docs/;
|
||||
sphinx-build -a -W -E -j auto -n -v . _build/html/;
|
||||
make build;
|
||||
make linkcheck;
|
||||
make linkcheck2;
|
||||
else
|
||||
.tests/test_single.sh . "${S1}" "${V1}" "${S2}" "${V2}";
|
||||
fi
|
||||
|
58
docs/Makefile
Normal file
@ -0,0 +1,58 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = devilbox
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
@echo
|
||||
@echo "Devilbox additional commands:"
|
||||
@echo " build Build and test documentation"
|
||||
@echo " autobuild Continuously run and build (http://127.0.0.1:8000)"
|
||||
|
||||
.PHONY: help Makefile test build autobuild
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
|
||||
#
|
||||
# Devilbox additions
|
||||
#
|
||||
#
|
||||
# Used Sphinx options:
|
||||
# --------------------
|
||||
#
|
||||
# -a: Always write all output files. The default is to only write output files
|
||||
# for new and changed source files.
|
||||
#
|
||||
# -E: Don’t use a saved environment (the structure caching all cross-references),
|
||||
# but rebuild it completely.
|
||||
#
|
||||
# -n: Run in nit-picky mode. Currently, this generates warnings for all
|
||||
# missing references. See the config value nitpick_ignore for a way to
|
||||
# exclude some references as “known missing”.
|
||||
#
|
||||
# -q: Do not output anything on standard output, only write warnings and errors
|
||||
# to standard error.
|
||||
#
|
||||
# -W: Turn warnings into errors. This means that the build stops at the first
|
||||
# warning and sphinx-build exits with exit status 1.
|
||||
|
||||
|
||||
linkcheck2:
|
||||
./linkcheck.sh -r 10 -t 10 -e rst _includes/
|
||||
|
||||
build:
|
||||
sphinx-build -a -E -n -j auto -q -W . _build/html
|
||||
|
||||
autobuild:
|
||||
sphinx-autobuild . _build/html
|
@ -26,17 +26,15 @@ sudo pip install sphinx_rtd_theme
|
||||
#### How to build and error-check
|
||||
```
|
||||
cd docs/
|
||||
sphinx-build -a -E -j auto -n -q . _build/html/
|
||||
make build
|
||||
```
|
||||
|
||||
#### How to build continuously
|
||||
```
|
||||
cd docs/
|
||||
sphinx-autobuild . _build/html
|
||||
make autobuild
|
||||
```
|
||||
|
||||
#### How to view
|
||||
|
||||
Open you browser on http://127.0.0.1:8000
|
||||
|
||||
|
||||
When using `make autobuild` your documentation is served at: http://127.0.0.1:8000
|
||||
|
38
docs/_includes/all.rst
Normal file
@ -0,0 +1,38 @@
|
||||
..
|
||||
============================================================
|
||||
HTML
|
||||
============================================================
|
||||
|
||||
.. include:: /_includes/html/defaults.rst
|
||||
|
||||
|
||||
|
||||
..
|
||||
============================================================
|
||||
Images
|
||||
============================================================
|
||||
|
||||
.. include:: /_includes/images/external.rst
|
||||
|
||||
|
||||
|
||||
..
|
||||
============================================================
|
||||
Links
|
||||
============================================================
|
||||
|
||||
.. include:: /_includes/links/apps.rst
|
||||
.. include:: /_includes/links/blogs.rst
|
||||
.. include:: /_includes/links/dns.rst
|
||||
.. include:: /_includes/links/documentation.rst
|
||||
.. include:: /_includes/links/docker.rst
|
||||
.. include:: /_includes/links/docker-compose.rst
|
||||
.. include:: /_includes/links/docker-images.rst
|
||||
.. include:: /_includes/links/examples.rst
|
||||
.. include:: /_includes/links/git.rst
|
||||
.. include:: /_includes/links/prerequistes.rst
|
||||
.. include:: /_includes/links/ssh.rst
|
||||
.. include:: /_includes/links/ssl.rst
|
||||
.. include:: /_includes/links/tools.rst
|
||||
.. include:: /_includes/links/uid.rst
|
||||
.. include:: /_includes/links/xdebug.rst
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
2
docs/_includes/figures/blogs/youtube-email-catch-all.rst
Normal file
@ -0,0 +1,2 @@
|
||||
.. figure:: /_includes/figures/blogs/youtube-email-catch-all.png
|
||||
:target: https://www.youtube.com/watch?v=e-U-C5WhxGY
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
@ -0,0 +1,2 @@
|
||||
.. figure:: /_includes/figures/blogs/youtube-setup-and-workflow.png
|
||||
:target: https://www.youtube.com/watch?v=reyZMyt2Zzo
|
Before Width: | Height: | Size: 120 KiB After Width: | Height: | Size: 120 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-dash-all.png
|
||||
|
||||
Devilbox intranet: index dash view for all started container
|
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-dash-selective.png
|
||||
|
||||
Devilbox intranet: index dash view for some started container
|
Before Width: | Height: | Size: 135 KiB After Width: | Height: | Size: 135 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-emails.png
|
||||
|
||||
Devilbox intranet: email catch-all overview
|
Before Width: | Height: | Size: 355 KiB After Width: | Height: | Size: 355 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-index.png
|
||||
|
||||
Devilbox intranet: homepage
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-mysql-databases.png
|
||||
|
||||
Devilbox intranet: MySQL database overview
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 117 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-mysql-info.png
|
||||
|
||||
Devilbox intranet: MySQL info overview
|
Before Width: | Height: | Size: 300 KiB After Width: | Height: | Size: 300 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-php-info.png
|
||||
|
||||
Devilbox intranet: php info
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-empty.png
|
||||
|
||||
Devilbox intranet: no projects created
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-missing-dns.png
|
||||
|
||||
Devilbox intranet: misssing dns record
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-missing-htdocs.png
|
||||
|
||||
Devilbox intranet: misssing ``htdocs`` directory
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-working.png
|
||||
|
||||
Devilbox intranet: vhost setup successfully
|
Before Width: | Height: | Size: 141 KiB After Width: | Height: | Size: 141 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts.png
|
||||
|
||||
Devilbox intranet: available virtual hosts
|
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 5.1 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-project-hello-world.png
|
||||
|
||||
Devilbox project: hello world on ``index.php``
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/devilbox/devilbox-project-missing-index.png
|
||||
|
||||
Devilbox project: misssing ``index.php`` or ``index.html``
|
After Width: | Height: | Size: 68 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/android/android-wifi-advanced-options.jpg
|
||||
:width: 250px
|
||||
|
||||
Android: Advanced options
|
BIN
docs/_includes/figures/dns-server/android/android-wifi-list.jpg
Normal file
After Width: | Height: | Size: 58 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/android/android-wifi-list.jpg
|
||||
:width: 250px
|
||||
|
||||
Android: Wi-Fi list
|
After Width: | Height: | Size: 70 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/android/android-wifi-select-dhcp-options-static.jpg
|
||||
:width: 250px
|
||||
|
||||
Android: Select static DHCP options
|
After Width: | Height: | Size: 68 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/android/android-wifi-select-dhcp-options.jpg
|
||||
:width: 250px
|
||||
|
||||
Android: Select DHCP options
|
After Width: | Height: | Size: 69 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/android/android-wifi-set-dns-server.jpg
|
||||
:width: 250px
|
||||
|
||||
Android: Add custom DNS server
|
BIN
docs/_includes/figures/dns-server/iphone/iphone-wifi-list.jpg
Normal file
After Width: | Height: | Size: 53 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/iphone/iphone-wifi-list.jpg
|
||||
:width: 250px
|
||||
|
||||
iPhone: Wi-Fi list
|
After Width: | Height: | Size: 43 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/iphone/iphone-wifi-select-manual.jpg
|
||||
:width: 250px
|
||||
|
||||
iPhone: Wi-Fi list
|
After Width: | Height: | Size: 55 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/iphone/iphone-wifi-set-dns-server.jpg
|
||||
:width: 250px
|
||||
|
||||
iPhone: Wi-Fi list
|
After Width: | Height: | Size: 64 KiB |
@ -0,0 +1,4 @@
|
||||
.. figure:: /_includes/figures/dns-server/iphone/iphone-wifi-settings.jpg
|
||||
:width: 250px
|
||||
|
||||
iPhone: Wi-Fi list
|
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/dns-server/mac/mac-network-settings.png
|
||||
|
||||
MacOS: network settings
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/dns-server/windows/win-ethernet-properties.png
|
||||
|
||||
Windows: ethernet properties
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/dns-server/windows/win-internet-protocol-properties.png
|
||||
|
||||
Windows: internet protocol properties
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/dns-server/windows/win-network-connections.png
|
||||
|
||||
Windows: network connections
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/chrome-advanced-settings.png
|
||||
|
||||
Click on ``Manage certificates``
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/chrome-manage-certificates.png
|
||||
|
||||
Click on ``IMPORT`` in the AUTHORITIES tab
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
3
docs/_includes/figures/https/chrome-set-trust.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/chrome-set-trust.png
|
||||
|
||||
Tell Chrome to trust this CA
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
3
docs/_includes/figures/https/chrome-settings.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/chrome-settings.png
|
||||
|
||||
Click on ``Advanced``
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
3
docs/_includes/figures/https/file-manager-import-ca.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/file-manager-import-ca.png
|
||||
|
||||
**Note**: your file manager might look different
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/firefox-certificate-manager.png
|
||||
|
||||
Click on ``Import`` in the Authorities tab
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
3
docs/_includes/figures/https/firefox-preferences.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/firefox-preferences.png
|
||||
|
||||
Click on ``Privacy & Security`` in the left menu bar
|
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 152 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/firefox-privacy-and-security.png
|
||||
|
||||
Click on ``View Certificates``
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
3
docs/_includes/figures/https/firefox-set-trust.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/firefox-set-trust.png
|
||||
|
||||
Tell Firefox to trust this CA
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
3
docs/_includes/figures/https/https-ssl-address-bar.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/https/https-ssl-address-bar.png
|
||||
|
||||
Valid HTTPS will automatically be available for all projects
|
After Width: | Height: | Size: 119 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/terminal/docker-toolbox-terminal-mac-quickstart-launchpad.png
|
||||
|
||||
Copyright docs.docker.com
|
After Width: | Height: | Size: 21 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-shortcut.png
|
||||
|
||||
Copyright docs.docker.com
|
After Width: | Height: | Size: 6.6 KiB |
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-terminal.png
|
||||
|
||||
Copyright docs.docker.com
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 118 KiB |
3
docs/_includes/figures/xdebug/phpstorm-dbgp-proxy.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/xdebug/phpstorm-dbgp-proxy.png
|
||||
|
||||
PHPStorm settings: DBGp Proxy
|
Before Width: | Height: | Size: 199 KiB After Width: | Height: | Size: 199 KiB |
3
docs/_includes/figures/xdebug/phpstorm-path-mapping.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/xdebug/phpstorm-path-mapping.png
|
||||
|
||||
PHPStorm settings: path mapping
|
Before Width: | Height: | Size: 189 KiB After Width: | Height: | Size: 189 KiB |
3
docs/_includes/figures/xdebug/phpstorm-settings.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. figure:: /_includes/figures/xdebug/phpstorm-settings.png
|
||||
|
||||
PHPStorm settings: Xdebug
|
3
docs/_includes/html/defaults.rst
Normal file
@ -0,0 +1,3 @@
|
||||
.. |br| raw:: html
|
||||
|
||||
<br />
|
5
docs/_includes/images/external.rst
Normal file
@ -0,0 +1,5 @@
|
||||
.. |img_logo_lin| image:: https://raw.githubusercontent.com/cytopia/icons/master/64x64/linux.png
|
||||
.. |img_logo_mac| image:: https://raw.githubusercontent.com/cytopia/icons/master/64x64/osx.png
|
||||
.. |img_logo_win| image:: https://raw.githubusercontent.com/cytopia/icons/master/64x64/windows.png
|
||||
|
||||
.. |img_banner| image:: /img/banner.png
|
12
docs/_includes/links/apps.rst
Normal file
@ -0,0 +1,12 @@
|
||||
.. |ext_lnk_app_android_dns_changer| raw:: html
|
||||
|
||||
<a target="_blank" href="https://play.google.com/store/apps/details?id=com.burakgon.dnschanger">
|
||||
DNS Changer <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_app_iphone_dns_override| raw:: html
|
||||
|
||||
<a target="_blank" href="https://itunes.apple.com/us/app/dns-override/id1060830093">
|
||||
DNS Override <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
23
docs/_includes/links/blogs.rst
Normal file
@ -0,0 +1,23 @@
|
||||
.. |ext_lnk_blog_deliciousbrains| raw:: html
|
||||
|
||||
<a target="_blank" href="https://deliciousbrains.com/devilbox-local-wordpress-development-docker/">
|
||||
Using Devilbox For Local WordPress Development In Docker <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_blog_moritzkanzler| raw:: html
|
||||
|
||||
<a target="_blank" href="https://blog.moritzkanzler.de/devilbox-lokaler-webserver-mit-apache-php-und-mysql-im-docker-container/">
|
||||
Devilbox: Lokaler Webserver mit Apache, PHP und MySQL im Docker Container <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_blog_joomla_pr_testing_platform| raw:: html
|
||||
|
||||
<a target="_blank" href="https://docs.joomla.org/PR_Testing_Platform">
|
||||
PR Testing Platform <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_blog_joomla_gsoc2017| raw:: html
|
||||
|
||||
<a target="_blank" href="https://docs.joomla.org/GSOC_2017">
|
||||
Google Summer of Code 2017 <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
29
docs/_includes/links/dns.rst
Normal file
@ -0,0 +1,29 @@
|
||||
.. |ext_lnk_dns_archlinux_wiki_resolv_conf| raw:: html
|
||||
|
||||
<a target="_blank" href="https://wiki.archlinux.org/index.php/Dhcpcd#resolv.conf">
|
||||
Archlinux Wiki: resolv.conf <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_wikipedia_cname| raw:: html
|
||||
|
||||
<a target="_blank" href="https://en.wikipedia.org/wiki/CNAME_record">
|
||||
CNAME <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_domain_dev| raw:: html
|
||||
|
||||
<a target="_blank" href="https://icannwiki.org/.dev">
|
||||
Google (ICANN) <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_domain_rfc_localhost| raw:: html
|
||||
|
||||
<a target="_blank" href="https://tools.ietf.org/html/draft-west-let-localhost-be-localhost-06">
|
||||
RFC Draft: localhost <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|
||||
|
||||
.. |ext_lnk_domain_docker_rel_notes_localhost| raw:: html
|
||||
|
||||
<a target="_blank" href="https://docs.docker.com/docker-for-mac/release-notes/#docker-community-edition-17120-ce-mac46-2018-01-09">
|
||||
Docker Release notes: 17.12.0-ce-mac46 <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
|
||||
</a>
|