From e71aaa66dbf52f0e0b7033ba7615ff61838354f1 Mon Sep 17 00:00:00 2001 From: licanwei Date: Mon, 17 Feb 2020 11:53:46 +0800 Subject: [PATCH] simplify doc directory Change-Id: I11bfa4d3bcb7c01ef638c0fa97cb872e96698e29 --- doc/source/admin/index.rst | 1 + doc/source/contributor/index.rst | 3 +- doc/source/contributor/plugin/index.rst | 4 ++ doc/source/contributor/testing.rst | 6 +- doc/source/index.rst | 78 ++----------------------- doc/source/install/index.rst | 6 +- doc/source/man/index.rst | 4 ++ 7 files changed, 21 insertions(+), 81 deletions(-) diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 762e78d4e..f77b0de61 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -10,4 +10,5 @@ Administrator Guide policy ../strategies/index ../datasources/index + ../contributor/notifications ../contributor/concurrency diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 0c756ff1e..fc1b17974 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -1,5 +1,5 @@ ================== -Contribution guide +Contribution Guide ================== .. toctree:: @@ -8,6 +8,5 @@ Contribution guide contributing environment devstack - notifications testing rally_link diff --git a/doc/source/contributor/plugin/index.rst b/doc/source/contributor/plugin/index.rst index 4fedb0189..41d935729 100644 --- a/doc/source/contributor/plugin/index.rst +++ b/doc/source/contributor/plugin/index.rst @@ -1,3 +1,7 @@ +============ +Plugin Guide +============ + .. toctree:: :maxdepth: 1 diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index 585c42fa6..8dde16d09 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -4,9 +4,9 @@ https://creativecommons.org/licenses/by/3.0/ -======= -Testing -======= +================= +Developer Testing +================= .. _unit_tests: diff --git a/doc/source/index.rst b/doc/source/index.rst index bcb19cdb0..b3fed7b09 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -32,89 +32,21 @@ specific prior release. .. _python-watcherclient: https://opendev.org/openstack/python-watcherclient/ .. _watcher-dashboard: https://opendev.org/openstack/watcher-dashboard/ -Developer Guide -=============== - -Introduction ------------- - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - glossary architecture - -Getting Started ---------------- - -.. toctree:: - :maxdepth: 1 - contributor/index - -Installation -============ -.. toctree:: - :maxdepth: 2 - install/index - -Admin Guide -=========== - -.. toctree:: - :maxdepth: 2 - admin/index - -User Guide -========== - -.. toctree:: - :maxdepth: 2 - user/index - -API References -============== + configuration/index + contributor/plugin/index + man/index .. toctree:: :maxdepth: 1 API Reference Watcher API Microversion History - -Plugins -------- - -.. toctree:: - :maxdepth: 1 - - contributor/plugin/index - -Watcher Configuration Options -============================= - -.. toctree:: - :maxdepth: 2 - - configuration/index - -Watcher Manual Pages -==================== - -.. toctree:: - :glob: - :maxdepth: 1 - - man/index - - -.. only:: html - -Indices and tables -================== - - * :ref:`genindex` - * :ref:`modindex` - * :ref:`search` + glossary diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 4e66ddc20..b211f3f40 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -1,6 +1,6 @@ -=================================== -Infrastructure Optimization service -=================================== +============= +Install Guide +============= .. toctree:: :maxdepth: 2 diff --git a/doc/source/man/index.rst b/doc/source/man/index.rst index 33c625965..d6d2be6f8 100644 --- a/doc/source/man/index.rst +++ b/doc/source/man/index.rst @@ -1,3 +1,7 @@ +==================== +Watcher Manual Pages +==================== + .. toctree:: :glob: :maxdepth: 1