diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 9f240ddbb..ce695e949 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -6,6 +6,6 @@ Glossary :maxdepth: 3 :caption: Contents: - testing/contents + testing/glossary index diff --git a/docs/source/index.rst b/docs/source/index.rst index ba309a017..4239ead35 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,7 +12,7 @@ Testing ======= * :doc:`Testing with ceph-ansible ` -* :doc:`Glossary ` +* :doc:`Glossary ` OSDs diff --git a/docs/source/testing/contents.rst b/docs/source/testing/glossary.rst similarity index 85% rename from docs/source/testing/contents.rst rename to docs/source/testing/glossary.rst index 1441ef8b0..b3f2de8aa 100644 --- a/docs/source/testing/contents.rst +++ b/docs/source/testing/glossary.rst @@ -11,5 +11,5 @@ Glossary scenarios.rst modifying.rst layout.rst - - + tests.rst + tox.rst diff --git a/docs/source/testing/index.rst b/docs/source/testing/index.rst index 93ddfc3ae..cb5d5d1bd 100644 --- a/docs/source/testing/index.rst +++ b/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` | diff --git a/docs/source/testing/layout.rst b/docs/source/testing/layout.rst index 9f196a637..7f7d7874d 100644 --- a/docs/source/testing/layout.rst +++ b/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`` +------------- diff --git a/docs/source/testing/scenarios.rst b/docs/source/testing/scenarios.rst index 031e1abf1..b65029a9a 100644 --- a/docs/source/testing/scenarios.rst +++ b/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 +--------------------- diff --git a/docs/source/testing/tests.rst b/docs/source/testing/tests.rst new file mode 100644 index 000000000..854038ccc --- /dev/null +++ b/docs/source/testing/tests.rst @@ -0,0 +1,10 @@ +.. _tests: + +Tests +===== + +.. _test_files: + +Test Files +---------- + diff --git a/docs/source/testing/tox.rst b/docs/source/testing/tox.rst new file mode 100644 index 000000000..4e398b20f --- /dev/null +++ b/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 +-------------------------------- diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 000000000..028c343f6 --- /dev/null +++ b/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