Merge pull request #1421 from ceph/tox-docs

tox-driven docs

docs/source/glossary.rst

@@ -6,6 +6,6 @@ Glossary
    :maxdepth: 3
    :caption: Contents:
 
-   testing/contents
+   testing/glossary
    index
 

docs/source/index.rst

@@ -12,7 +12,7 @@ Testing
 =======
 
 * :doc:`Testing with ceph-ansible <testing/index>`
-* :doc:`Glossary <testing/contents>`
+* :doc:`Glossary <testing/glossary>`
 
 
 OSDs

docs/source/testing/glossary.rst

@@ -11,5 +11,5 @@ Glossary
    scenarios.rst
    modifying.rst
    layout.rst
-
+   tests.rst
-
+   tox.rst

docs/source/testing/index.rst

@@ -27,7 +27,7 @@ a behavior.
 * **Adding or modifying a scenario:**
   :ref:`scenario_conventions` |
   :ref:`scenario_environment_configuration` |
-  :ref:`scneario_ansible_configuration` |
+  :ref:`scenario_ansible_configuration` |
 
 * **Custom/development repositories and packages:**
   :ref:`tox_environment_variables` |

docs/source/testing/layout.rst

@@ -28,3 +28,13 @@ At the very least, a scenario will need these files:
   machines, networks, disks, linux distro/version, can be defined.
 
 
+.. _test_conventions:
+
+Conventions
+-----------
+
+
+.. _testinfra:
+
+``testinfra``
+-------------

docs/source/testing/scenarios.rst

@@ -3,3 +3,28 @@
 
 Test Scenarios
 ==============
+
+.. _scenario_files:
+
+Scenario Files
+--------------
+
+.. _scenario_wiring:
+
+Scenario Wiring
+---------------
+
+.. _scenario_conventions:
+
+Conventions
+-----------
+
+.. _scenario_environment_configuration:
+
+Environment configuration
+-------------------------
+
+.. _scenario_ansible_configuration:
+
+Ansible configuration
+---------------------

docs/source/testing/tests.rst

@@ -0,0 +1,10 @@
+.. _tests:
+
+Tests
+=====
+
+.. _test_files:
+
+Test Files
+----------
+

docs/source/testing/tox.rst

@@ -0,0 +1,22 @@
+.. _tox:
+
+``tox``
+=======
+
+
+.. _tox_environment_variables:
+
+Environment variables
+---------------------
+
+
+.. _tox_sections:
+
+Sections
+--------
+
+
+.. _tox_environments:
+
+Modifying or Adding environments
+--------------------------------

docs/tox.ini

@@ -0,0 +1,10 @@
+[tox]
+envlist = docs
+skipsdist = True
+
+[testenv:docs]
+basepython=python
+changedir=source
+deps=sphinx
+commands=
+    sphinx-build -W -b html -d {envtmpdir}/doctrees .  {envtmpdir}/html