From 6e245635d1814e7db1807be7aaf8d2dd66b8ebb0 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 29 Mar 2017 13:53:15 +0200 Subject: [PATCH] Reorganize appendix in toc Move glossary and appendix in one chapter called appendix. This has been done already for arch-design and ops-guide, do it for the other guides. Share common appendix. Change-Id: I6bf4e94f6c0569850cca6558be672de298bb208c --- doc/admin-guide/source/appendix.rst | 9 +++++++ doc/admin-guide/source/conf.py | 3 ++- doc/admin-guide/source/index.rst | 22 +---------------- doc/arch-design-to-archive/source/index.rst | 23 +----------------- doc/arch-design/source/index.rst | 2 +- doc/cli-reference/source/index.rst | 5 ---- doc/common/appendix.rst | 8 +++++++ doc/config-reference/source/appendix.rst | 8 +++++++ doc/config-reference/source/index.rst | 15 +----------- doc/contributor-guide/source/conf.py | 1 + doc/ha-guide-draft/source/index.rst | 3 +-- .../source/appendix.rst | 1 + doc/ha-guide/source/conf.py | 1 + doc/ha-guide/source/index.rst | 18 +------------- doc/image-guide/source/index.rst | 24 +------------------ doc/install-guide-debconf/source/index.rst | 24 +------------------ doc/install-guide/source/index.rst | 24 +------------------ doc/networking-guide/source/index.rst | 24 +------------------ doc/ops-guide/source/conf.py | 1 + doc/user-guide/source/index.rst | 24 +------------------ 20 files changed, 42 insertions(+), 198 deletions(-) create mode 100644 doc/admin-guide/source/appendix.rst create mode 100644 doc/common/appendix.rst create mode 100644 doc/config-reference/source/appendix.rst rename doc/{arch-design => ha-guide}/source/appendix.rst (83%) diff --git a/doc/admin-guide/source/appendix.rst b/doc/admin-guide/source/appendix.rst new file mode 100644 index 0000000000..ae763cf121 --- /dev/null +++ b/doc/admin-guide/source/appendix.rst @@ -0,0 +1,9 @@ +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + firewalls-default-ports.rst + common/app-support.rst + common/glossary.rst diff --git a/doc/admin-guide/source/conf.py b/doc/admin-guide/source/conf.py index 8b85fbcdc8..62d1b5408b 100644 --- a/doc/admin-guide/source/conf.py +++ b/doc/admin-guide/source/conf.py @@ -90,7 +90,8 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag, # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] +exclude_patterns = ['common/appendix.rst' +] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/admin-guide/source/index.rst b/doc/admin-guide/source/index.rst index 447fa4c974..f3214d70a5 100644 --- a/doc/admin-guide/source/index.rst +++ b/doc/admin-guide/source/index.rst @@ -31,25 +31,5 @@ Contents orchestration.rst cli.rst cross-project.rst - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - firewalls-default-ports.rst + appendix.rst common/app-support.rst - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary.rst - -Search -~~~~~~ - -* :ref:`search` diff --git a/doc/arch-design-to-archive/source/index.rst b/doc/arch-design-to-archive/source/index.rst index c1dcb622bd..b18a05fc2d 100644 --- a/doc/arch-design-to-archive/source/index.rst +++ b/doc/arch-design-to-archive/source/index.rst @@ -32,25 +32,4 @@ Contents massively-scalable.rst specialized.rst references.rst - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/app-support.rst - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary.rst - -Search in this guide -~~~~~~~~~~~~~~~~~~~~ - -* :ref:`search` - + common/appendix.rst diff --git a/doc/arch-design/source/index.rst b/doc/arch-design/source/index.rst index 4abf2714cb..b65f9d437a 100644 --- a/doc/arch-design/source/index.rst +++ b/doc/arch-design/source/index.rst @@ -40,4 +40,4 @@ Contents arch-requirements.rst design.rst use-cases.rst - appendix.rst + common/appendix.rst diff --git a/doc/cli-reference/source/index.rst b/doc/cli-reference/source/index.rst index 64f0b2b71f..4fe1d1157a 100644 --- a/doc/cli-reference/source/index.rst +++ b/doc/cli-reference/source/index.rst @@ -58,8 +58,3 @@ Contents ceilometer gnocchi mistral - -Search -~~~~~~ - -* :ref:`search` diff --git a/doc/common/appendix.rst b/doc/common/appendix.rst new file mode 100644 index 0000000000..1d7d814376 --- /dev/null +++ b/doc/common/appendix.rst @@ -0,0 +1,8 @@ +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + app-support.rst + glossary.rst diff --git a/doc/config-reference/source/appendix.rst b/doc/config-reference/source/appendix.rst new file mode 100644 index 0000000000..7cd7f830fb --- /dev/null +++ b/doc/config-reference/source/appendix.rst @@ -0,0 +1,8 @@ +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + policy-yaml-file.rst + policy-json-file.rst diff --git a/doc/config-reference/source/index.rst b/doc/config-reference/source/index.rst index dcf4d3d42d..29d6462130 100644 --- a/doc/config-reference/source/index.rst +++ b/doc/config-reference/source/index.rst @@ -35,17 +35,4 @@ Contents orchestration.rst shared-file-systems.rst telemetry.rst - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - policy-yaml-file.rst - policy-json-file.rst - -Search -~~~~~~ - -* :ref:`search` + appendix.rst diff --git a/doc/contributor-guide/source/conf.py b/doc/contributor-guide/source/conf.py index ef01176254..6f39b23f0c 100644 --- a/doc/contributor-guide/source/conf.py +++ b/doc/contributor-guide/source/conf.py @@ -94,6 +94,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag, # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['common/app-support.rst', 'common/cli*', 'common/nova*', + 'common/appendix.rst', 'common/get-started*', 'common/dashboard*', 'common/conventions.rst'] diff --git a/doc/ha-guide-draft/source/index.rst b/doc/ha-guide-draft/source/index.rst index 87bb04a894..23d3ae73de 100644 --- a/doc/ha-guide-draft/source/index.rst +++ b/doc/ha-guide-draft/source/index.rst @@ -34,5 +34,4 @@ This guide documents OpenStack Ocata, Newton, and Mitaka releases. testing.rst ref-arch-examples.rst ha-community.rst - common/app-support.rst - common/glossary.rst + common/appendix.rst diff --git a/doc/arch-design/source/appendix.rst b/doc/ha-guide/source/appendix.rst similarity index 83% rename from doc/arch-design/source/appendix.rst rename to doc/ha-guide/source/appendix.rst index ca6b1a7182..1453312b2c 100644 --- a/doc/arch-design/source/appendix.rst +++ b/doc/ha-guide/source/appendix.rst @@ -4,5 +4,6 @@ Appendix .. toctree:: :maxdepth: 1 + ha-community.rst common/app-support.rst common/glossary.rst diff --git a/doc/ha-guide/source/conf.py b/doc/ha-guide/source/conf.py index a1f2930842..27d9297887 100644 --- a/doc/ha-guide/source/conf.py +++ b/doc/ha-guide/source/conf.py @@ -90,6 +90,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag, # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['common/cli*', 'common/nova*', + 'common/appendix.rst', 'common/get-started*', 'common/dashboard*'] # The reST default role (used for this markup: `text`) to use for all diff --git a/doc/ha-guide/source/index.rst b/doc/ha-guide/source/index.rst index 650b1d1afd..c87d346e98 100644 --- a/doc/ha-guide/source/index.rst +++ b/doc/ha-guide/source/index.rst @@ -33,20 +33,4 @@ Contents networking-ha.rst storage-ha.rst compute-node-ha.rst - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - ha-community.rst - common/app-support.rst - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary.rst + appendix.rst diff --git a/doc/image-guide/source/index.rst b/doc/image-guide/source/index.rst index 20131b65c8..17848a4a02 100644 --- a/doc/image-guide/source/index.rst +++ b/doc/image-guide/source/index.rst @@ -23,26 +23,4 @@ Contents create-images-automatically.rst convert-images.rst share-images.rst - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/app-support.rst - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary.rst - -.. only:: html - - Search - ~~~~~~ - - * :ref:`search` + common/appendix.rst diff --git a/doc/install-guide-debconf/source/index.rst b/doc/install-guide-debconf/source/index.rst index 80158593a5..9fd1c7981f 100644 --- a/doc/install-guide-debconf/source/index.rst +++ b/doc/install-guide-debconf/source/index.rst @@ -45,26 +45,4 @@ Contents horizon.rst cinder.rst launch-instance.rst - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/app-support.rst - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary.rst - -.. only:: html - - Search - ~~~~~~ - - * :ref:`search` + common/appendix.rst diff --git a/doc/install-guide/source/index.rst b/doc/install-guide/source/index.rst index 41833bf388..0e5b2c909d 100644 --- a/doc/install-guide/source/index.rst +++ b/doc/install-guide/source/index.rst @@ -119,6 +119,7 @@ Contents cinder.rst additional-services.rst launch-instance.rst + common/appendix.rst .. Pseudo only directive for each distribution used by the build tool. This pseudo only directive for toctree only works fine with Tox. @@ -129,26 +130,3 @@ Contents .. only:: obs or rdo or ubuntu .. only:: debian .. end of contents - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/app-support.rst - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary.rst - -.. only:: html - - Search - ~~~~~~ - - * :ref:`search` diff --git a/doc/networking-guide/source/index.rst b/doc/networking-guide/source/index.rst index 7e7157960f..8045667063 100644 --- a/doc/networking-guide/source/index.rst +++ b/doc/networking-guide/source/index.rst @@ -28,26 +28,4 @@ Contents ops migration misc - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/app-support - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary - -.. only:: html - - Search - ~~~~~~ - - * :ref:`search` + common/appendix.rst diff --git a/doc/ops-guide/source/conf.py b/doc/ops-guide/source/conf.py index 8ae12fd60b..63534cf3dc 100644 --- a/doc/ops-guide/source/conf.py +++ b/doc/ops-guide/source/conf.py @@ -90,6 +90,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag, # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['common/cli*', 'common/nova*', + 'common/appendix.rst', 'common/get-started*', 'common/dashboard*'] # The reST default role (used for this markup: `text`) to use for all diff --git a/doc/user-guide/source/index.rst b/doc/user-guide/source/index.rst index a14eca3272..e44dda1604 100644 --- a/doc/user-guide/source/index.rst +++ b/doc/user-guide/source/index.rst @@ -26,26 +26,4 @@ Contents sdk.rst hot.rst cli-cheat-sheet.rst - -Appendix -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/app-support.rst - -Glossary -~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - common/glossary.rst - -.. only:: html - - Search - ~~~~~~ - - * :ref:`search` + common/appendix.rst