Unification content of the index.rst file

In the index.rst file, sometime, we declare that name_of_file.rst,
sometime is name_of_file.

For example. the content of the barbican/doc/source/api/index.rst
is that:

"""
    ./reference/secrets
    ./reference/secret_types
    ./reference/secret_metadata
    ./reference/store_backends.rst
    ./reference/containers
    ./reference/acls
    ./reference/quotas
    ./reference/consumers
    ./reference/orders
"""
That is confusing, it should be like below:

"""
    ./reference/secrets.rst
    ./reference/secret_types.rst
    ./reference/secret_metadata.rst
    ./reference/store_backends.rst
    ./reference/containers.rst
    ./reference/acls.rst
    ./reference/quotas.rst
    ./reference/consumers.rst
    ./reference/orders.rst
"""

Change-Id: I54ca41bb27f59caaaddab977ef4a3cf7f66bb5f3
Closes-Bug: #1694180
This commit is contained in:
Nam Nguyen Hoai 2017-05-30 09:46:51 +07:00
parent a6f49f94b4
commit 341fb3c4f3
4 changed files with 32 additions and 32 deletions

View File

@ -14,12 +14,12 @@ API Reference
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
./reference/secrets ./reference/secrets.rst
./reference/secret_types ./reference/secret_types.rst
./reference/secret_metadata ./reference/secret_metadata.rst
./reference/store_backends.rst ./reference/store_backends.rst
./reference/containers ./reference/containers.rst
./reference/acls ./reference/acls.rst
./reference/quotas ./reference/quotas.rst
./reference/consumers ./reference/consumers.rst
./reference/orders ./reference/orders.rst

View File

@ -17,7 +17,7 @@ API.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
api/index api/index.rst
Barbican for Developers Barbican for Developers
======================= =======================
@ -33,22 +33,22 @@ development environment.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
setup/dev setup/dev.rst
setup/devstack setup/devstack.rst
When you're ready to dive deeper in to barbican take a look at: When you're ready to dive deeper in to barbican take a look at:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
contribute/getting_involved contribute/getting_involved.rst
contribute/architecture contribute/architecture.rst
contribute/structure contribute/structure.rst
contribute/dataflow contribute/dataflow.rst
contribute/dependencies contribute/dependencies.rst
contribute/database_migrations contribute/database_migrations.rst
plugin/index plugin/index.rst
testing testing.rst
Barbican for Operators Barbican for Operators
====================== ======================
@ -59,9 +59,9 @@ will probably want to read:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
setup/index setup/index.rst
admin-guide-cloud/index admin-guide-cloud/index.rst
upgrade/index upgrade/index.rst
This documentation is generated by the Sphinx toolkit and lives in the source This documentation is generated by the Sphinx toolkit and lives in the source
tree. tree.

View File

@ -69,5 +69,5 @@ Barbican, as well as configuration and deployment options.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
secret_store secret_store.rst
crypto crypto.rst

View File

@ -4,11 +4,11 @@ Setting up Barbican
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
dev dev.rst
keystone keystone.rst
devstack devstack.rst
certificate certificate.rst
troubleshooting troubleshooting.rst
noauth noauth.rst
audit audit.rst
plugin_backends plugin_backends.rst