simplify doc directory

Change-Id: I11bfa4d3bcb7c01ef638c0fa97cb872e96698e29
This commit is contained in:
licanwei 2020-02-17 11:53:46 +08:00
parent 2591b03625
commit e71aaa66db
7 changed files with 21 additions and 81 deletions

View File

@ -10,4 +10,5 @@ Administrator Guide
policy policy
../strategies/index ../strategies/index
../datasources/index ../datasources/index
../contributor/notifications
../contributor/concurrency ../contributor/concurrency

View File

@ -1,5 +1,5 @@
================== ==================
Contribution guide Contribution Guide
================== ==================
.. toctree:: .. toctree::
@ -8,6 +8,5 @@ Contribution guide
contributing contributing
environment environment
devstack devstack
notifications
testing testing
rally_link rally_link

View File

@ -1,3 +1,7 @@
============
Plugin Guide
============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

View File

@ -4,9 +4,9 @@
https://creativecommons.org/licenses/by/3.0/ https://creativecommons.org/licenses/by/3.0/
======= =================
Testing Developer Testing
======= =================
.. _unit_tests: .. _unit_tests:

View File

@ -32,89 +32,21 @@ specific prior release.
.. _python-watcherclient: https://opendev.org/openstack/python-watcherclient/ .. _python-watcherclient: https://opendev.org/openstack/python-watcherclient/
.. _watcher-dashboard: https://opendev.org/openstack/watcher-dashboard/ .. _watcher-dashboard: https://opendev.org/openstack/watcher-dashboard/
Developer Guide
===============
Introduction
------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
glossary
architecture architecture
Getting Started
---------------
.. toctree::
:maxdepth: 1
contributor/index contributor/index
Installation
============
.. toctree::
:maxdepth: 2
install/index install/index
Admin Guide
===========
.. toctree::
:maxdepth: 2
admin/index admin/index
User Guide
==========
.. toctree::
:maxdepth: 2
user/index user/index
configuration/index
API References contributor/plugin/index
============== man/index
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
API Reference <https://docs.openstack.org/api-ref/resource-optimization/> API Reference <https://docs.openstack.org/api-ref/resource-optimization/>
Watcher API Microversion History </contributor/api_microversion_history> Watcher API Microversion History </contributor/api_microversion_history>
glossary
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`

View File

@ -1,6 +1,6 @@
=================================== =============
Infrastructure Optimization service Install Guide
=================================== =============
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -1,3 +1,7 @@
====================
Watcher Manual Pages
====================
.. toctree:: .. toctree::
:glob: :glob:
:maxdepth: 1 :maxdepth: 1