openstack
/
openstack-manuals
Code Issues Proposed changes

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
This commit is contained in:
Andreas Jaeger 2017-03-29 13:53:15 +02:00
parent 2e931e7db9
commit 6e245635d1
20 changed files with 42 additions and 198 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/admin-guide/source/appendix.rst Normal file
View File

@ -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
View File

@ -90,7 +90,8 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # 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 # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.

22
doc/admin-guide/source/index.rst
View File

@ -31,25 +31,5 @@ Contents
orchestration.rst orchestration.rst
cli.rst cli.rst
cross-project.rst cross-project.rst
appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
firewalls-default-ports.rst
common/app-support.rst common/app-support.rst
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
common/glossary.rst
Search
~~~~~~
* :ref:`search`

23
doc/arch-design-to-archive/source/index.rst
View File

@ -32,25 +32,4 @@ Contents
massively-scalable.rst massively-scalable.rst
specialized.rst specialized.rst
references.rst references.rst
common/appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
common/app-support.rst
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
common/glossary.rst
Search in this guide
~~~~~~~~~~~~~~~~~~~~
* :ref:`search`

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

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

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

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

8
doc/common/appendix.rst Normal file
View File

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

8
doc/config-reference/source/appendix.rst Normal file
View File

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

15
doc/config-reference/source/index.rst
View File

@ -35,17 +35,4 @@ Contents
orchestration.rst orchestration.rst
shared-file-systems.rst shared-file-systems.rst
telemetry.rst telemetry.rst
appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
policy-yaml-file.rst
policy-json-file.rst
Search
~~~~~~
* :ref:`search`

1
doc/contributor-guide/source/conf.py
View File

@ -94,6 +94,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['common/app-support.rst', 'common/cli*', 'common/nova*', exclude_patterns = ['common/app-support.rst', 'common/cli*', 'common/nova*',
'common/appendix.rst',
'common/get-started*', 'common/dashboard*', 'common/get-started*', 'common/dashboard*',
'common/conventions.rst'] 'common/conventions.rst']

3
doc/ha-guide-draft/source/index.rst
View File

@ -34,5 +34,4 @@ This guide documents OpenStack Ocata, Newton, and Mitaka releases.
testing.rst testing.rst
ref-arch-examples.rst ref-arch-examples.rst
ha-community.rst ha-community.rst
common/app-support.rst common/appendix.rst
common/glossary.rst

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

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

1
doc/ha-guide/source/conf.py
View File

@ -90,6 +90,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['common/cli*', 'common/nova*', exclude_patterns = ['common/cli*', 'common/nova*',
'common/appendix.rst',
'common/get-started*', 'common/dashboard*'] 'common/get-started*', 'common/dashboard*']
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all

18
doc/ha-guide/source/index.rst
View File

@ -33,20 +33,4 @@ Contents
networking-ha.rst networking-ha.rst
storage-ha.rst storage-ha.rst
compute-node-ha.rst compute-node-ha.rst
appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
ha-community.rst
common/app-support.rst
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
common/glossary.rst

24
doc/image-guide/source/index.rst
View File

@ -23,26 +23,4 @@ Contents
create-images-automatically.rst create-images-automatically.rst
convert-images.rst convert-images.rst
share-images.rst share-images.rst
common/appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
common/app-support.rst
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
common/glossary.rst
.. only:: html
Search
~~~~~~
* :ref:`search`

24
doc/install-guide-debconf/source/index.rst
View File

@ -45,26 +45,4 @@ Contents
horizon.rst horizon.rst
cinder.rst cinder.rst
launch-instance.rst launch-instance.rst
common/appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
common/app-support.rst
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
common/glossary.rst
.. only:: html
Search
~~~~~~
* :ref:`search`

24
doc/install-guide/source/index.rst
View File

@ -119,6 +119,7 @@ Contents
cinder.rst cinder.rst
additional-services.rst additional-services.rst
launch-instance.rst launch-instance.rst
common/appendix.rst
.. Pseudo only directive for each distribution used by the build tool. .. Pseudo only directive for each distribution used by the build tool.
This pseudo only directive for toctree only works fine with Tox. This pseudo only directive for toctree only works fine with Tox.
@ -129,26 +130,3 @@ Contents
.. only:: obs or rdo or ubuntu .. only:: obs or rdo or ubuntu
.. only:: debian .. only:: debian
.. end of contents .. 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
View File

@ -28,26 +28,4 @@ Contents
ops ops
migration migration
misc misc
common/appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
common/app-support
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
common/glossary
.. only:: html
Search
~~~~~~
* :ref:`search`

1
doc/ops-guide/source/conf.py
View File

@ -90,6 +90,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['common/cli*', 'common/nova*', exclude_patterns = ['common/cli*', 'common/nova*',
'common/appendix.rst',
'common/get-started*', 'common/dashboard*'] 'common/get-started*', 'common/dashboard*']
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all

24
doc/user-guide/source/index.rst
View File

@ -26,26 +26,4 @@ Contents
sdk.rst sdk.rst
hot.rst hot.rst
cli-cheat-sheet.rst cli-cheat-sheet.rst
common/appendix.rst
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
common/app-support.rst
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
common/glossary.rst
.. only:: html
Search
~~~~~~
* :ref:`search`