Skip to content

Commit

Permalink
The ini format used for hosts by Ansible might not be compatible for …
Browse files Browse the repository at this point in the history
…docs.

Playing around with Sphinx and Pygments the problem was the "hostname"
line which might be uncommon/illegal in normal ini files.

Since Sphinx 1.3.5 this becomes a warning and in the DebOps projects,
warnings are handled as errors :)
sphinx-doc/sphinx#1565

Disable ini highlighting for now.
  • Loading branch information
ypid committed Jan 24, 2016
1 parent bf9698a commit de22d1c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/guides/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ the project directory this file is located in ``ansible/inventory/hosts``. Open
it in your favorite text editor and add the remote host in the main DebOps
host group:

.. code-block:: ini
.. code-block:: none
[debops_all_hosts]
server ansible_ssh_host=server.example.com
Expand Down Expand Up @@ -122,7 +122,7 @@ Ansible depends on SSH defaults which conventionally use the name of the
current user as the remote username. It's customary to specify this variable
directly in the ``hosts`` file, that way it can be unique for each host:

.. code-block:: ini
.. code-block:: none
[debops_all_hosts]
server ansible_ssh_host=server.example.com ansible_ssh_user=ansible-admin
Expand Down Expand Up @@ -358,7 +358,7 @@ role in Ansible inventory. This is done by creating a new host group,
``[debops_service_dokuwiki]`` in the ``hosts`` file, and adding the desired
hosts to it:

.. code-block:: ini
.. code-block:: none
[debops_all_hosts]
server ansible_ssh_host=server.example.com
Expand Down

0 comments on commit de22d1c

Please sign in to comment.