Skip to content

Commit

Permalink
Documentation restructuring
Browse files Browse the repository at this point in the history
  • Loading branch information
cytopia committed Jul 26, 2018
1 parent 0121371 commit acab8b3
Show file tree
Hide file tree
Showing 169 changed files with 2,210 additions and 864 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ build:
sphinx-build -a -E -n -j auto -q -W . _build/html

autobuild:
sphinx-autobuild -E -n -j auto . _build/html
sphinx-autobuild . _build/html
8 changes: 3 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions docs/_includes/figures/blogs/youtube-email-catch-all.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. figure:: /_includes/figures/blogs/youtube-email-catch-all.png
:target: https://www.youtube.com/watch?v=e-U-C5WhxGY
2 changes: 2 additions & 0 deletions docs/_includes/figures/blogs/youtube-setup-and-workflow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. figure:: /_includes/figures/blogs/youtube-setup-and-workflow.png
:target: https://www.youtube.com/watch?v=reyZMyt2Zzo
File renamed without changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-dash-all.png

Devilbox intranet: index dash view for all started container
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-dash-selective.png

Devilbox intranet: index dash view for some started container
File renamed without changes
3 changes: 3 additions & 0 deletions docs/_includes/figures/devilbox/devilbox-intranet-emails.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-emails.png

Devilbox intranet: email catch-all overview
File renamed without changes
3 changes: 3 additions & 0 deletions docs/_includes/figures/devilbox/devilbox-intranet-index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-index.png

Devilbox intranet: homepage
File renamed without changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-mysql-databases.png

Devilbox intranet: MySQL database overview
File renamed without changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-mysql-info.png

Devilbox intranet: MySQL info overview
File renamed without changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-php-info.png

Devilbox intranet: php info
File renamed without changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-empty.png

Devilbox intranet: no projects created
File renamed without changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-missing-dns.png

Devilbox intranet: misssing dns record
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-missing-htdocs.png

Devilbox intranet: misssing ``htdocs`` directory
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts-working.png

Devilbox intranet: vhost setup successfully
File renamed without changes
3 changes: 3 additions & 0 deletions docs/_includes/figures/devilbox/devilbox-intranet-vhosts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-intranet-vhosts.png

Devilbox intranet: available virtual hosts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-project-hello-world.png

Devilbox project: hello world on ``index.php``
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/devilbox/devilbox-project-missing-index.png

Devilbox project: misssing ``index.php`` or ``index.html``
File renamed without changes
3 changes: 3 additions & 0 deletions docs/_includes/figures/dns/mac-network-settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/dns/mac-network-settings.png

MacOS: network settings
3 changes: 3 additions & 0 deletions docs/_includes/figures/dns/win-ethernet-properties.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/dns/win-ethernet-properties.png

Windows: ethernet properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/dns/win-internet-protocol-properties.png

Windows: internet protocol properties
3 changes: 3 additions & 0 deletions docs/_includes/figures/dns/win-network-connections.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/dns/win-network-connections.png

Windows: network connections
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/chrome-advanced-settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/chrome-advanced-settings.png

Click on ``Manage certificates``
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/chrome-manage-certificates.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/chrome-manage-certificates.png

Click on ``IMPORT`` in the AUTHORITIES tab
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/chrome-set-trust.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/chrome-set-trust.png

Tell Chrome to trust this CA
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/chrome-settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/chrome-settings.png

Click on ``Advanced``
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/file-manager-import-ca.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/file-manager-import-ca.png

**Note**: your file manager might look different
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/firefox-certificate-manager.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/firefox-certificate-manager.png

Click on ``Import`` in the Authorities tab
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/firefox-preferences.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/firefox-preferences.png

Click on ``Privacy & Security`` in the left menu bar
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/firefox-privacy-and-security.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/firefox-privacy-and-security.png

Click on ``View Certificates``
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/firefox-set-trust.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/firefox-set-trust.png

Tell Firefox to trust this CA
3 changes: 3 additions & 0 deletions docs/_includes/figures/https/https-ssl-address-bar.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/https/https-ssl-address-bar.png

Valid HTTPS will automatically be available for all projects
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/terminal/docker-toolbox-terminal-mac-quickstart-launchpad.png

Copyright docs.docker.com
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-shortcut.png

Copyright docs.docker.com
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-terminal.png

Copyright docs.docker.com
3 changes: 3 additions & 0 deletions docs/_includes/figures/xdebug/phpstorm-dbgp-proxy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/xdebug/phpstorm-dbgp-proxy.png

PHPStorm settings: DBGp Proxy
3 changes: 3 additions & 0 deletions docs/_includes/figures/xdebug/phpstorm-path-mapping.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/xdebug/phpstorm-path-mapping.png

PHPStorm settings: path mapping
3 changes: 3 additions & 0 deletions docs/_includes/figures/xdebug/phpstorm-settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /_includes/figures/xdebug/phpstorm-settings.png

PHPStorm settings: Xdebug
5 changes: 5 additions & 0 deletions docs/_includes/global/images.rst
Original file line number Diff line number Diff line change
@@ -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/mac.png
.. |img_logo_win| image:: https://raw.githubusercontent.com/cytopia/icons/master/64x64/windows.png

.. |img_banner| image:: /img/banner.png
157 changes: 157 additions & 0 deletions docs/_includes/global/links.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
..
============================================================
Docker
============================================================
.. |ext_lnk_install_docker| raw:: html

<a target="_blank" href="https://docs.docker.com/install/">
Install Docker <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_link_docker_machine| raw:: html

<a target="_blank" href="https://docs.docker.com/machine/overview/">
Docker Machine <img src="/_static/img/icons/ext-link.svg" />
</a>

..
============================================================
Docker for Linux
============================================================
.. |ext_lnk_install_docker_centos| raw:: html

<a target="_blank" href="https://docs.docker.com/install/linux/docker-ce/centos/">
Get Docker CE for CentOS <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_debian| raw:: html

<a target="_blank" href="https://docs.docker.com/install/linux/docker-ce/debian/">
Get Docker CE for Debian <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_fedora| raw:: html

<a target="_blank" href="https://docs.docker.com/install/linux/docker-ce/fedora/">
Get Docker CE for Fedora <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_ubuntu| raw:: html

<a target="_blank" href="https://docs.docker.com/install/linux/docker-ce/ubuntu/">
Get Docker CE for Ubuntu <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_linux_post_steps| raw:: html

<a target="_blank" href="https://docs.docker.com/install/linux/linux-postinstall/">
Post-installation steps for Linux <img src="/_static/img/icons/ext-link.svg" />
</a>


..
============================================================
Docker for Mac
============================================================
.. |ext_lnk_install_docker_mac| raw:: html

<a target="_blank" href="https://docs.docker.com/docker-for-mac/install/">
Install Docker for Mac <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_mac_get_started| raw:: html

<a target="_blank" href="https://docs.docker.com/docker-for-mac/">
Get started with Docker for Mac <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_toolbox_mac| raw:: html

<a target="_blank" href="https://docs.docker.com/toolbox/toolbox_install_mac/">
Install Docker Toolbox on macOS <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_toolbox_mac_native_vs_toolbox| raw:: html

<a target="_blank" href="https://docs.docker.com/docker-for-mac/docker-toolbox/">
Docker for Mac vs. Docker Toolbox <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_toolbox_mac_shared_directory| raw:: html

<a target="_blank" href="https://docs.docker.com/toolbox/toolbox_install_mac/#optional-add-shared-directories">
Docker Toolbox on Mac: add shared directories <img src="/_static/img/icons/ext-link.svg" />
</a>


..
============================================================
Docker for Windows
============================================================
.. |ext_lnk_install_docker_win| raw:: html

<a target="_blank" href="https://docs.docker.com/docker-for-windows/install/">
Install Docker for Windows <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_win_get_started| raw:: html

<a target="_blank" href="https://docs.docker.com/docker-for-windows/">
Get started with Docker for Windows <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_toolbox_win| raw:: html

<a target="_blank" href="https://docs.docker.com/toolbox/toolbox_install_windows/">
Install Docker Toolbox on Windows <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_install_docker_toolbox_win_shared_directory| raw:: html

<a target="_blank" href="https://docs.docker.com/toolbox/toolbox_install_windows/#optional-add-shared-directories">
Docker Toolbox on Windows: add shared directories <img src="/_static/img/icons/ext-link.svg" />
</a>


..
============================================================
Docker Compose
============================================================
.. |ext_lnk_install_docker_compose| raw:: html

<a target="_blank" href="https://docs.docker.com/compose/install/">
Install Docker Compose <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_docker_cmpose_cmd_reference| raw:: html

<a target="_blank" href="https://docs.docker.com/compose/reference/">
Compose command-line reference <img src="/_static/img/icons/ext-link.svg" />
</a>

.. |ext_lnk_docker_cmpose_env_file| raw:: html

<a target="_blank" href="https://docs.docker.com/compose/env-file/">
Declare default environment variables in file <img src="/_static/img/icons/ext-link.svg" />
</a>


..
============================================================
Misc
============================================================
.. -------------------- uid --------------------
.. |ext_lnk_uid| raw:: html

<a target="_blank" href="https://en.wikipedia.org/wiki/User_identifier">
Wikipedia: uid <img src="/_static/img/icons/ext-link.svg" />
</a>


19 changes: 19 additions & 0 deletions docs/_static/css/custom.css → docs/_static/css/devilbox.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/************************************************************
* MENU
***********************************************************/

/* overwrite logo dimensions */
.wy-side-nav-search>a img.logo,
.wy-side-nav-search .wy-dropdown>a img.logo {
Expand All @@ -9,6 +13,21 @@
background-color: #343131;
}

/* sidebar category headlines */
.wy-menu-vertical header, .wy-menu-vertical p.caption {
margin-top: 25px;
margin-bottom: 15px;
padding: 0 1.518em;
padding-top:10px;
border-top: 1px solid #9b9b9b;
font-size: 100%;
}


/************************************************************
* Code blocks
***********************************************************/

/* Disable annoying scrollbar in code-blocks */
.codeblock,
pre.literal-block,
Expand Down
Loading

0 comments on commit acab8b3

Please sign in to comment.