From 341fb3c4f31e325d21a9534e4e0ab1624ec2f934 Mon Sep 17 00:00:00 2001 From: Nam Nguyen Hoai Date: Tue, 30 May 2017 09:46:51 +0700 Subject: [PATCH] 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 --- doc/source/api/index.rst | 16 ++++++++-------- doc/source/index.rst | 28 ++++++++++++++-------------- doc/source/plugin/index.rst | 4 ++-- doc/source/setup/index.rst | 16 ++++++++-------- 4 files changed, 32 insertions(+), 32 deletions(-) diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index 8f519298..c955fc55 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -14,12 +14,12 @@ API Reference .. toctree:: :maxdepth: 1 - ./reference/secrets - ./reference/secret_types - ./reference/secret_metadata + ./reference/secrets.rst + ./reference/secret_types.rst + ./reference/secret_metadata.rst ./reference/store_backends.rst - ./reference/containers - ./reference/acls - ./reference/quotas - ./reference/consumers - ./reference/orders + ./reference/containers.rst + ./reference/acls.rst + ./reference/quotas.rst + ./reference/consumers.rst + ./reference/orders.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 8b551abd..5a7da294 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,7 +17,7 @@ API. .. toctree:: :maxdepth: 1 - api/index + api/index.rst Barbican for Developers ======================= @@ -33,22 +33,22 @@ development environment. .. toctree:: :maxdepth: 1 - setup/dev - setup/devstack + setup/dev.rst + setup/devstack.rst When you're ready to dive deeper in to barbican take a look at: .. toctree:: :maxdepth: 1 - contribute/getting_involved - contribute/architecture - contribute/structure - contribute/dataflow - contribute/dependencies - contribute/database_migrations - plugin/index - testing + contribute/getting_involved.rst + contribute/architecture.rst + contribute/structure.rst + contribute/dataflow.rst + contribute/dependencies.rst + contribute/database_migrations.rst + plugin/index.rst + testing.rst Barbican for Operators ====================== @@ -59,9 +59,9 @@ will probably want to read: .. toctree:: :maxdepth: 1 - setup/index - admin-guide-cloud/index - upgrade/index + setup/index.rst + admin-guide-cloud/index.rst + upgrade/index.rst This documentation is generated by the Sphinx toolkit and lives in the source tree. diff --git a/doc/source/plugin/index.rst b/doc/source/plugin/index.rst index e9bda410..0d915ab6 100644 --- a/doc/source/plugin/index.rst +++ b/doc/source/plugin/index.rst @@ -69,5 +69,5 @@ Barbican, as well as configuration and deployment options. .. toctree:: :maxdepth: 1 - secret_store - crypto + secret_store.rst + crypto.rst diff --git a/doc/source/setup/index.rst b/doc/source/setup/index.rst index ac81eced..90b8c1b1 100644 --- a/doc/source/setup/index.rst +++ b/doc/source/setup/index.rst @@ -4,11 +4,11 @@ Setting up Barbican .. toctree:: :maxdepth: 1 - dev - keystone - devstack - certificate - troubleshooting - noauth - audit - plugin_backends + dev.rst + keystone.rst + devstack.rst + certificate.rst + troubleshooting.rst + noauth.rst + audit.rst + plugin_backends.rst