From 14d46cb2be8edb93f2764ca18e35e414cf4e07ec Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 11:41:59 -0400 Subject: [PATCH 01/10] docs: create a separate docs tox.ini Signed-off-by: Alfredo Deza --- docs/tox.ini | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/tox.ini 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 From a5b2ede0fff71df42f44ca4747b22f2cfb007359 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:05:55 -0400 Subject: [PATCH 02/10] docs: normalize the glossary vs. contents files Signed-off-by: Alfredo Deza --- docs/source/testing/{contents.rst => glossary.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/source/testing/{contents.rst => glossary.rst} (100%) diff --git a/docs/source/testing/contents.rst b/docs/source/testing/glossary.rst similarity index 100% rename from docs/source/testing/contents.rst rename to docs/source/testing/glossary.rst From ae6349fd2187361cecc807fc7b9a8aa5fe023a16 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:06:16 -0400 Subject: [PATCH 03/10] docs: add the testing glossary in the toctree Signed-off-by: Alfredo Deza --- docs/source/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 41815f6b538f97a139eb6ce14dec2b4e117874aa Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:06:36 -0400 Subject: [PATCH 04/10] docs: use glossary for the :doc: directive Signed-off-by: Alfredo Deza --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From cb504f6d88b0259ec8a4b6cad8bc9ed9a25c2d14 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:07:26 -0400 Subject: [PATCH 05/10] docs: create a separate tox doc file Signed-off-by: Alfredo Deza --- docs/source/testing/tox.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/source/testing/tox.rst 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 +-------------------------------- From f895b4c376739aa9b2b69c0b1239137f93bb1f7f Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:07:42 -0400 Subject: [PATCH 06/10] docs: create a tests doc file Signed-off-by: Alfredo Deza --- docs/source/testing/tests.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/source/testing/tests.rst 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 +---------- + From 3cde692482288c35f6b158ce058705d4f1777f50 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:17:13 -0400 Subject: [PATCH 07/10] docs: include the tests and tox files in the glossary Signed-off-by: Alfredo Deza --- docs/source/testing/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/testing/glossary.rst b/docs/source/testing/glossary.rst index 1441ef8b0..b3f2de8aa 100644 --- a/docs/source/testing/glossary.rst +++ b/docs/source/testing/glossary.rst @@ -11,5 +11,5 @@ Glossary scenarios.rst modifying.rst layout.rst - - + tests.rst + tox.rst From 7eb26d1b002072c2d33d662b15c483dc7867d167 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:17:31 -0400 Subject: [PATCH 08/10] docs: fix typo in testing/index.rst Signed-off-by: Alfredo Deza --- docs/source/testing/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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` | From c768f342192aae017e5969b4a4776cc287008874 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:17:53 -0400 Subject: [PATCH 09/10] docs: include testing conventions and testinfra in layout.rst Signed-off-by: Alfredo Deza --- docs/source/testing/layout.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) 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`` +------------- From e8ae5c6aaf8f4f111bc5ceb41997086a19d7547a Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Fri, 7 Apr 2017 12:18:15 -0400 Subject: [PATCH 10/10] docs: add missing sections/refs in scenarios.rst Signed-off-by: Alfredo Deza --- docs/source/testing/scenarios.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) 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 +---------------------