Check documentation via travis

.travis.yml

@@ -1,3 +1,8 @@
+###
+### Enable Python support
+###
+language: python
+
 ###
 ### Enable sudo (required for docker service)
 ###
@@ -15,6 +20,11 @@ services:
 ### Specify combinations
 ###
 env:
+  ###
+  ### Check Documentation
+  ###
+  - S1=DOCUMENTATION
+
   ###
   ### The matrix specifies 2 versions to compare against each other.
   ### As PHP (any version) needs to be able to run with everything,
@@ -111,6 +121,19 @@ before_install:
   - docker-compose version
 
 
+###
+### Installation
+###
+install:
+  # Install dependencies for documentation
+  - if [ "${S1}" = "DOCUMENTATION" ]; then
+      pip install sphinx;
+      pip install sphinx-autobuild;
+      pip install recommonmark;
+      pip install sphinx_rtd_theme;
+    fi
+
+
 ###
 ### Before Script
 ###
@@ -135,4 +158,9 @@ before_script:
 ### Test
 ###
 script:
-  - .tests/test_single.sh . "${S1}" "${V1}" "${S2}" "${V2}"
+  - if [ "${S1}" = "DOCUMENTATION" ]; then
+        cd docs/;
+        sphinx-build -a -W -E -j auto -n -v . _build/html/;
+    else
+        .tests/test_single.sh . "${S1}" "${V1}" "${S2}" "${V2}";
+    fi

docs/configuration-files/apache-conf.rst

@@ -71,7 +71,6 @@ Apache 2.2.
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: keep_alive.conf
    :caption: keep_alive.conf
 
    KeepAlive On
@@ -111,7 +110,6 @@ for Apache 2.4.
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: limits.conf
    :caption: limits.conf
 
    # Limit amount of HTTP headers a client can send to the server

docs/configuration-files/bashrc-sh.rst

@@ -53,7 +53,6 @@ by ``.sh`` and place it into the ``./bash/`` directory:
    host> vi ./bash/aliases.sh
 
 .. code-block:: bash
-    :name: ./bash/aliases.sh
    :caption: ./bash/aliases.sh
 
    alias l='ls -a'

docs/configuration-files/docker-compose-override-yml.rst

@@ -52,13 +52,10 @@ Create new file from scratch
 Let's see again how this file should look like now:
 
 .. code-block:: yaml
-    :name: docker-compose.override.yml
    :caption: docker-compose.override.yml
 
    version: '2.1'
 
-
-
 .. note::
    The documentation might be outdated and the version number might already be higher.
    Rely on the output of the ``grep`` command.

docs/configuration-files/env-file.rst

@@ -240,7 +240,6 @@ this project visible to everyone in your corporate LAN.
    should be redirected to the systems loopback interface.
    Docker has already released a commit preventing the use of ``localhost`` on MacOS.
 
-
    **See also:** `RFC Draft <https://tools.ietf.org/html/draft-west-let-localhost-be-localhost-06>`_
    and
    `Docker Release notes <https://docs.docker.com/docker-for-mac/release-notes/#docker-community-edition-17120-ce-mac46-2018-01-09>`_
@@ -534,7 +533,6 @@ All values are already available in the ``.env`` file and just need to be commen
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 7
 
    host> grep PHP_SERVER .env
@@ -566,7 +564,6 @@ All values are already available in the ``.env`` file and just need to be commen
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 5
 
    host> grep HTTPD_SERVER .env
@@ -594,7 +591,6 @@ All values are already available in the ``.env`` file and just need to be commen
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 9
 
    host> grep MYSQL_SERVER .env
@@ -630,7 +626,6 @@ All values are already available in the ``.env`` file and just need to be commen
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 8
 
    host> grep PGSQL_SERVER .env
@@ -666,7 +661,6 @@ All values are already available in the ``.env`` file and just need to be commen
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 6
 
    host> grep REDIS_SERVER .env
@@ -699,7 +693,6 @@ All values are already available in the ``.env`` file and just need to be commen
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 24
 
    host> grep MEMCD_SERVER .env
@@ -751,7 +744,6 @@ All values are already available in the ``.env`` file and just need to be commen
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 6
 
    host> grep MONGO_SERVER .env
@@ -814,7 +806,6 @@ like this:
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
 
    HOST_PATH_HTTPD_DATADIR=/home/myuser/workspace/web
 
@@ -1145,7 +1136,6 @@ Example:
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 2
 
    # Enable ionCube
@@ -1166,7 +1156,6 @@ Example:
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 2
 
    # Disable Xdebug, Imagick and Swoole
@@ -1184,7 +1173,6 @@ production, for example: ``APPLICATION_ENV``, you can just add this to the ``.en
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 3
 
    host> grep APPLICATION_ENV .env
@@ -1195,7 +1183,6 @@ Within your php application/file you can then access this variable via the ``get
 
 .. code-block:: php
    :caption: index.php
-   :name: index.php
    :emphasize-lines: 3
 
    <?php

docs/configuration-files/my-cnf.rst

@@ -78,7 +78,6 @@ of MySQL 5.5 to 16 MB.
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: memory_limit.cnf
    :caption: memory_limit.cnf
 
    [mysqld]
@@ -111,7 +110,6 @@ of PerconaDB 5.7
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: timeouts.cnf
    :caption: timeouts.cnf
 
    [mysqld]

docs/configuration-files/nginx-conf.rst

@@ -71,7 +71,6 @@ values of Nginx stable.
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: keep_alive.conf
    :caption: keep_alive.conf
 
    keepalive 10;
@@ -110,7 +109,6 @@ and
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: timeouts.conf
    :caption: timeouts.conf
 
    client_body_timeout 60s;

docs/configuration-files/php-fpm-conf.rst

@@ -78,7 +78,6 @@ of PHP-FPM 7.1 master process to 100.
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: rlimit.conf
    :caption: rlimit.conf
 
    [global]
@@ -115,7 +114,6 @@ of PHP-FPM 5.6 on pool ``www``.
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: www_server.conf
    :caption: www_server.conf
 
    [www]
@@ -158,7 +156,6 @@ The following example will disable built-in PHP functions globally and non-overw
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: admin.conf
    :caption: admin.conf
 
    [www]

docs/configuration-files/php-ini.rst

@@ -67,7 +67,6 @@ The following examples shows you how to change the
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: memory_limit.ini
    :caption: memory_limit.ini
 
    [PHP]
@@ -99,7 +98,6 @@ of PHP 5.6.
 Now add the following content to the file:
 
 .. code-block:: ini
-    :name: timeouts.ini
    :caption: timeouts.ini
 
    [PHP]

docs/configuration-global/auto-dns.rst

@@ -35,7 +35,6 @@ First ensure that :ref:`env_local_listen_addr` is either empty or listening on `
 
 .. code-block:: bash
    :caption: .env
-    :name: .env
    :emphasize-lines: 3
 
    host> cd path/to/devilbox
@@ -46,7 +45,6 @@ Then you need to ensure that :ref:`env_host_port_bind` is set to ``53``.
 
 .. code-block:: bash
    :caption: .env
-    :name: .env
    :emphasize-lines: 3
 
    host> cd path/to/devilbox
@@ -92,7 +90,6 @@ Add the following line to to the very beginning to ``/etc/dhcp/dhclient.conf``:
 
 .. code-block:: bash
    :caption: /etc/dhcp/dhclient.conf
-    :name: /etc/dhcp/dhclient.conf
 
    prepend domain-name-servers 127.0.0.1;
 
@@ -121,7 +118,6 @@ the very beginning to ``/etc/resolv.conf.head``:
 
 .. code-block:: bash
    :caption: /etc/resolv.conf.head
-    :name: /etc/resolv.conf.head
 
    nameserver 127.0.0.1
 
@@ -131,7 +127,6 @@ systemd-resolved by adding the following line under the ``[main]`` section of
 
 .. code-block:: bash
    :caption: /etc/NetworkManager/NetworkManager.conf
-    :name: /etc/NetworkManager/NetworkManager.conf
 
    dns=none
 

docs/examples/setup-cakephp.rst

@@ -96,7 +96,6 @@ It will be ready in eight simple steps:
 
 .. code-block:: php
    :caption: cakephp/config/app.php
-   :name: cakephp/config/app.php
    :emphasize-lines: 7,14,15,16
 
    <?php
@@ -131,7 +130,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-cake.loc
 

docs/examples/setup-codeigniter.rst

@@ -100,7 +100,6 @@ It will be ready in eight simple steps:
 
 .. code-block:: php
    :caption: htdocs/application/config/database.php
-   :name: htdocs/application/config/database.php
    :emphasize-lines: 4-7
 
    <?php
@@ -136,7 +135,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-ci.loc
 

docs/examples/setup-drupal.rst

@@ -86,7 +86,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-drupal.loc
 

docs/examples/setup-joomla.rst

@@ -88,7 +88,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-joomla.loc
 

docs/examples/setup-laravel.rst

@@ -86,7 +86,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-laravel.loc
 

docs/examples/setup-phalcon.rst

@@ -86,7 +86,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-phalcon.loc
 

docs/examples/setup-photon-cms.rst

@@ -96,7 +96,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-photon.loc
 

docs/examples/setup-symfony.rst

@@ -96,7 +96,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-symfony.loc
 

docs/examples/setup-wordpress.rst

@@ -86,7 +86,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-wp.loc
 

docs/examples/setup-yii.rst

@@ -86,7 +86,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-yii.loc
 

docs/examples/setup-zend.rst

@@ -86,7 +86,6 @@ following line to your host operating systems ``/etc/hosts`` file
 
 .. code-block:: bash
    :caption: /etc/hosts
-   :name: /etc/hosts
 
    127.0.0.1 my-zend.loc
 

docs/getting-started/best-practice.rst

@@ -45,7 +45,6 @@ All you have to to is to adjust the path of :ref:`env_httpd_datadir` in the ``.e
 Now Adjust the value of :ref:`env_httpd_datadir`
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
    :emphasize-lines: 1
 
@@ -79,7 +78,6 @@ All you have to to is to adjust the path of :ref:`env_mysql_datadir` in the ``.e
 Now Adjust the value of :ref:`env_mysql_datadir`
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
    :emphasize-lines: 1
 
@@ -104,7 +102,6 @@ All you have to to is to adjust the path of :ref:`env_pgsql_datadir` in the ``.e
 Now Adjust the value of :ref:`env_pgsql_datadir`
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
    :emphasize-lines: 1
 
@@ -129,7 +126,6 @@ All you have to to is to adjust the path of :ref:`env_mongo_datadir` in the ``.e
 Now Adjust the value of :ref:`env_mongo_datadir`
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
    :emphasize-lines: 1
 

docs/getting-started/create-your-first-project.rst

@@ -9,7 +9,6 @@ Create your first project
    going on under the hood.
 
 .. note::
-
    This section not only applies for one project, it applied for as many projects as you need.
    **There is no limit in the number of projects.**
 

docs/getting-started/install-the-devilbox.rst

@@ -145,7 +145,6 @@ Open the ``.env`` file with your favorite text editor and adjust those values:
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 3,4
 
    host> vi .env

docs/index.rst

@@ -66,7 +66,6 @@ host is ready to be served with your custom domain.
    tutorials/change-container-versions
    tutorials/work-inside-the-container
    tutorials/enable-xdebug
-   tutorials/custom-apache-modules
    tutorials/custom-environment-variables
    tutorials/static-code-analysis
 
@@ -94,7 +93,6 @@ host is ready to be served with your custom domain.
    :maxdepth: 2
 
    configuration-project/dns-records
-   configuration-project/domain
    configuration-project/custom-vhost
 
 

docs/installation/docker-toolbox.rst

@@ -74,6 +74,7 @@ If you do not port-forward it to your host machines localhost, you will have to
 DNS entries that are described in this documentation to go to ``127.0.0.1`` to the IP address of
 your virtual machine.
 
+.. _docker_toolbox_auto_dns:
 
 Auto-DNS
 --------

docs/tutorials/add-your-own-docker-image.rst

@@ -45,7 +45,6 @@ into it.
 
 .. code-block:: yaml
    :caption: docker-compose.override.yml
-    :name: docker-compose.override.yml
    :emphasize-lines: 4,5,8
 
    version: '2.1'
@@ -74,7 +73,6 @@ Two new services
 
 .. code-block:: yaml
    :caption: docker-compose.override.yml
-    :name: docker-compose.override.yml
    :emphasize-lines: 4,5,8,16,17,20
 
    version: '2.1'
@@ -132,7 +130,6 @@ Now add the information to ``docker-compose.override.yml``:
 
 .. code-block:: yaml
    :caption: docker-compose.override.yml
-    :name: docker-compose.override.yml
    :emphasize-lines: 4-5,9
 
    version: '2.1'

docs/tutorials/adding-subdomains.rst

@@ -68,8 +68,7 @@ you the option to customize the virtual host of this specific project.
    When adjusting vhost-gen templates for a project you have to do **one** of the following:
 
    * Restart the devilbox
-    * Or rename your project directory to some other name and then rename it back to its original
+   * Or rename your project directory to some other name and then rename it back to its original name.
-      name.
 
    More information here: :ref:`custom_vhost_apply_vhost_gen_changes`
 
@@ -153,7 +152,6 @@ here).
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/apache22.yml
-   :name: apache22.yml
    :emphasize-lines: 3
 
    vhost: |
@@ -177,7 +175,6 @@ All you will have to do, is to add another ``ServerName`` directive:
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/apache22.yml
-   :name: apache22.yml
    :emphasize-lines: 3,4
 
    vhost: |
@@ -232,7 +229,6 @@ here).
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/apache22.yml
-   :name: apache22.yml
    :emphasize-lines: 3
 
    vhost: |
@@ -256,7 +252,6 @@ All you will have to do, is to add another ``ServerName`` directive which does c
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/apache22.yml
-   :name: apache22.yml
    :emphasize-lines: 3,4
 
    vhost: |
@@ -325,7 +320,6 @@ here).
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/nginx.yml
-   :name: nginx.yml
    :emphasize-lines: 4
 
    vhost: |
@@ -350,7 +344,6 @@ All you will have to do, is to extend the ``server_name`` directive:
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/nginx.yml
-   :name: nginx.yml
    :emphasize-lines: 4
 
    vhost: |
@@ -407,7 +400,6 @@ here).
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/nginx.yml
-   :name: nginx.yml
    :emphasize-lines: 4
 
    vhost: |
@@ -432,7 +424,6 @@ All you will have to do, is to extend the ``server_name`` directive with a catch
 
 .. code-block:: yaml
    :caption: /home/user/devilbox/data/www/project-1/.devilbox/nginx.yml
-   :name: nginx.yml
    :emphasize-lines: 4
 
    vhost: |

docs/tutorials/change-container-versions.rst

@@ -36,7 +36,6 @@ It will look something like this:
 
 
 .. code-block:: bash
-   :name: .env
    :caption: .env
    :emphasize-lines: 5
 
@@ -59,7 +58,6 @@ To change this, simply uncomment your version of choice and save this file. Do n
 In order to enable PHP 5.5, you would change the ``.env`` file like this:
 
 .. code-block:: bash
-   :name: .env
    :caption: .env
    :emphasize-lines: 2
 
@@ -97,7 +95,6 @@ If two versions are uncommented, always the last one takes precedence.
 Consider this ``.env`` file:
 
 .. code-block:: bash
-   :name: .env
    :caption: .env
    :emphasize-lines: 2,4
 

docs/tutorials/communicating-with-external-hosts.rst

@@ -106,7 +106,6 @@ If you are running Linux as your host operating system you would use the IP addr
 computer which was identified as ``172.16.238.1``.
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
 
    EXTRA_HOSTS=mywebserver.loc=172.16.238.1
@@ -114,7 +113,6 @@ computer which was identified as ``172.16.238.1``.
 or
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
 
    EXTRA_HOSTS=mywebserver.loc=docker.for.lin.host.internal
@@ -122,7 +120,6 @@ or
 or
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
 
    EXTRA_HOSTS=mywebserver.loc=docker.for.lin.localhost
@@ -135,7 +132,6 @@ If you are running MacOS as your host operating system you would use one of the
 (depending on your Docker version).
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
 
    EXTRA_HOSTS=mywebserver.loc=host.docker.internal
@@ -151,7 +147,6 @@ If you are running Windows as your host operating system you would use one of th
 (depending on your Docker version).
 
 .. code-block:: bash
-    :name: .env
    :caption: .env
 
    EXTRA_HOSTS=mywebserver.loc=docker.for.win.host.internal

docs/tutorials/custom-environment-variables.rst

@@ -24,7 +24,6 @@ would add the following to the ``.env`` file:
 
 .. code-block:: bash
    :caption: .env
-   :name: .env
    :emphasize-lines: 1
 
    APPLICATION_ENV=production
@@ -44,7 +43,6 @@ You can use the PHP's built-in function ``getenv`` to obtain the value:
 
 .. code-block:: php
    :caption: index.php
-   :name: index.php
    :emphasize-lines: 3
 
    <?php

docs/tutorials/overwrite-existing-docker-image.rst

@@ -49,7 +49,6 @@ First you simply copy the while definition of the bind service from ``docker-com
 ``docker-compose.override.yml``:
 
 .. code-block:: yaml
-    :name: docker-compose.override.yml
    :caption: docker-compose.override.yml
 
    version: '2.1'
@@ -85,7 +84,6 @@ First you simply copy the while definition of the bind service from ``docker-com
 The second step is to remove everything that you do not need to overwrite:
 
 .. code-block:: yaml
-    :name: docker-compose.override.yml
    :caption: docker-compose.override.yml
 
    version: '2.1'
@@ -96,7 +94,6 @@ The second step is to remove everything that you do not need to overwrite:
 The last step is to actually adjust the value you want to change for the bind service:
 
 .. code-block:: yaml
-    :name: docker-compose.override.yml
    :caption: docker-compose.override.yml
    :emphasize-lines: 4