Browse Source

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
changes/59/451359/12
Andreas Jaeger 5 years ago
parent
commit
6e245635d1
  1. 9
      doc/admin-guide/source/appendix.rst
  2. 3
      doc/admin-guide/source/conf.py
  3. 22
      doc/admin-guide/source/index.rst
  4. 23
      doc/arch-design-to-archive/source/index.rst
  5. 2
      doc/arch-design/source/index.rst
  6. 5
      doc/cli-reference/source/index.rst
  7. 8
      doc/common/appendix.rst
  8. 8
      doc/config-reference/source/appendix.rst
  9. 15
      doc/config-reference/source/index.rst
  10. 1
      doc/contributor-guide/source/conf.py
  11. 3
      doc/ha-guide-draft/source/index.rst
  12. 1
      doc/ha-guide/source/appendix.rst
  13. 1
      doc/ha-guide/source/conf.py
  14. 18
      doc/ha-guide/source/index.rst
  15. 24
      doc/image-guide/source/index.rst
  16. 24
      doc/install-guide-debconf/source/index.rst
  17. 24
      doc/install-guide/source/index.rst
  18. 24
      doc/networking-guide/source/index.rst
  19. 1
      doc/ops-guide/source/conf.py
  20. 24
      doc/user-guide/source/index.rst

9
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

3
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.

22
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`

23
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

2
doc/arch-design/source/index.rst

@ -40,4 +40,4 @@ Contents
arch-requirements.rst
design.rst
use-cases.rst
appendix.rst
common/appendix.rst

5
doc/cli-reference/source/index.rst

@ -58,8 +58,3 @@ Contents
ceilometer
gnocchi
mistral
Search
~~~~~~
* :ref:`search`

8
doc/common/appendix.rst

@ -0,0 +1,8 @@
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
app-support.rst
glossary.rst

8
doc/config-reference/source/appendix.rst

@ -0,0 +1,8 @@
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
policy-yaml-file.rst
policy-json-file.rst

15
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

1
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']

3
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

1
doc/arch-design/source/appendix.rst → doc/ha-guide/source/appendix.rst

@ -4,5 +4,6 @@ Appendix
.. toctree::
:maxdepth: 1
ha-community.rst
common/app-support.rst
common/glossary.rst

1
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

18
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

24
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

24
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

24
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`

24
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

1
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

24
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

Loading…
Cancel
Save