openstack/python-openstackclient
Code Issues Proposed changes

Split plugin docs per project

Browse Source 
Once [1] fixed plugin doc generation, the (single) page it produced was
unusably huge. This commit splits it into one page per project.

Note that there are four plugin projects that didn't have sections
included:

- cue
- murano
- tripleo
- watcher

These were noted in hidden rst which is preserved in the (new) index
page.

[1] Id9be39971110fd2eb4519a0582c9bf2514cdcacd

Change-Id: I0214ddb00a5a292a46d7cfb539d6dcc540fdae79
Story: #1735016
Task: #37239
This commit is contained in:
Eric Fried 2019-10-21 17:05:57 -05:00
parent 8cdc7348d1
commit 85c83530ee
24 changed files with 153 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/_extra/.htaccess
View File

@ -20,3 +20,4 @@ redirectmatch 301 ^/python-openstackclient/([^/]+)/command-wrappers.html$ /pytho
redirectmatch 301 ^/python-openstackclient/([^/]+)/developing.html$ /python-openstackclient/$1/contributor/developing.html
redirectmatch 301 ^/python-openstackclient/([^/]+)/humaninterfaceguide.html$ /python-openstackclient/$1/contributor/humaninterfaceguide.html
redirectmatch 301 ^/python-openstackclient/([^/]+)/plugins.html$ /python-openstackclient/$1/contributor/plugins.html
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/plugin-commands.html$ /python-openstackclient/$1/cli/plugin-commands/index.html

2
doc/source/cli/index.rst
View File

@ -8,7 +8,7 @@
Manual Page <man/openstack>
command-list
commands
plugin-commands
plugin-commands/index
authentication
interactive
decoder

146
doc/source/cli/plugin-commands.rst
View File

@ -1,146 +0,0 @@
.. _plugin-commands:
===============
Plugin Commands
===============
.. list-plugins:: openstack.cli.extension
aodh
----
.. list-plugins:: openstack.alarming.v2
:detailed:
barbican
--------
.. list-plugins:: openstack.key_manager.v1
:detailed:
congress
--------
.. list-plugins:: openstack.congressclient.v1
:detailed:
.. cue
.. # cueclient is not in global-requirements
.. # list-plugins:: openstack.mb.v1
.. # :detailed:
designate
---------
.. list-plugins:: openstack.dns.v2
:detailed:
gnocchi
-------
.. list-plugins:: openstack.metric.v1
:detailed:
heat
----
.. list-plugins:: openstack.orchestration.v1
:detailed:
ironic
------
.. list-plugins:: openstack.baremetal.v1
:detailed:
ironic-inspector
----------------
.. list-plugins:: openstack.baremetal_introspection.v1
:detailed:
karbor
------
.. list-plugins:: openstack.data_protection.v1
:detailed:
mistral
-------
.. list-plugins:: openstack.workflow_engine.v2
:detailed:
.. murano
.. # the murano docs cause warnings and a broken docs build
.. # .. list-plugins:: openstack.application_catalog.v1
.. # :detailed:
neutron
-------
.. list-plugins:: openstack.neutronclient.v2
:detailed:
octavia
-------
.. list-plugins:: openstack.load_balancer.v2
:detailed:
placement
---------
.. list-plugins:: openstack.placement.v1
:detailed:
rsd
---
.. list-plugins:: openstack.rsd.v1
:detailed:
sahara
------
.. list-plugins:: openstack.data_processing.v1
:detailed:
searchlight
-----------
.. list-plugins:: openstack.search.v1
:detailed:
senlin
------
.. list-plugins:: openstack.clustering.v1
:detailed:
.. tripleo
.. # tripleoclient is not in global-requirements
.. # list-plugins:: openstack.tripleoclient.v1
.. # :detailed:
trove
------
.. list-plugins:: openstack.database.v1
:detailed:
.. watcher
.. # watcherclient is not in global-requirements
.. # list-plugins:: openstack.infra_optim.v1
.. # :detailed:
zaqar
-----
.. list-plugins:: openstack.messaging.v2
:detailed:
zun
---
.. list-plugins:: openstack.container.v1
:detailed:

5
doc/source/cli/plugin-commands/aodh.rst Normal file
View File

@ -0,0 +1,5 @@
aodh
----
.. list-plugins:: openstack.alarming.v2
:detailed:

5
doc/source/cli/plugin-commands/barbican.rst Normal file
View File

@ -0,0 +1,5 @@
barbican
--------
.. list-plugins:: openstack.key_manager.v1
:detailed:

5
doc/source/cli/plugin-commands/congress.rst Normal file
View File

@ -0,0 +1,5 @@
congress
--------
.. list-plugins:: openstack.congressclient.v1
:detailed:

5
doc/source/cli/plugin-commands/designate.rst Normal file
View File

@ -0,0 +1,5 @@
designate
---------
.. list-plugins:: openstack.dns.v2
:detailed:

5
doc/source/cli/plugin-commands/gnocchi.rst Normal file
View File

@ -0,0 +1,5 @@
gnocchi
-------
.. list-plugins:: openstack.metric.v1
:detailed:

5
doc/source/cli/plugin-commands/heat.rst Normal file
View File

@ -0,0 +1,5 @@
heat
----
.. list-plugins:: openstack.orchestration.v1
:detailed:

51
doc/source/cli/plugin-commands/index.rst Normal file
View File

@ -0,0 +1,51 @@
.. _plugin-commands:
===============
Plugin Commands
===============
.. toctree::
:maxdepth: 1
aodh
barbican
congress
designate
gnocchi
heat
ironic
ironic-inspector
karbor
mistral
neutron
octavia
placement
rsd
sahara
searchlight
senlin
trove
zaqar
zun
.. TODO(efried): Make pages for the following once they're fixed.
.. cue
.. # cueclient is not in global-requirements
.. # list-plugins:: openstack.mb.v1
.. # :detailed:
.. murano
.. # the murano docs cause warnings and a broken docs build
.. # .. list-plugins:: openstack.application_catalog.v1
.. # :detailed:
.. tripleo
.. # tripleoclient is not in global-requirements
.. # list-plugins:: openstack.tripleoclient.v1
.. # :detailed:
.. watcher
.. # watcherclient is not in global-requirements
.. # list-plugins:: openstack.infra_optim.v1
.. # :detailed:

5
doc/source/cli/plugin-commands/ironic-inspector.rst Normal file
View File

@ -0,0 +1,5 @@
ironic-inspector
----------------
.. list-plugins:: openstack.baremetal_introspection.v1
:detailed:

5
doc/source/cli/plugin-commands/ironic.rst Normal file
View File

@ -0,0 +1,5 @@
ironic
------
.. list-plugins:: openstack.baremetal.v1
:detailed:

5
doc/source/cli/plugin-commands/karbor.rst Normal file
View File

@ -0,0 +1,5 @@
karbor
------
.. list-plugins:: openstack.data_protection.v1
:detailed:

5
doc/source/cli/plugin-commands/mistral.rst Normal file
View File

@ -0,0 +1,5 @@
mistral
-------
.. list-plugins:: openstack.workflow_engine.v2
:detailed:

5
doc/source/cli/plugin-commands/neutron.rst Normal file
View File

@ -0,0 +1,5 @@
neutron
-------
.. list-plugins:: openstack.neutronclient.v2
:detailed:

5
doc/source/cli/plugin-commands/octavia.rst Normal file
View File

@ -0,0 +1,5 @@
octavia
-------
.. list-plugins:: openstack.load_balancer.v2
:detailed:

5
doc/source/cli/plugin-commands/placement.rst Normal file
View File

@ -0,0 +1,5 @@
placement
---------
.. list-plugins:: openstack.placement.v1
:detailed:

5
doc/source/cli/plugin-commands/rsd.rst Normal file
View File

@ -0,0 +1,5 @@
rsd
---
.. list-plugins:: openstack.rsd.v1
:detailed:

5
doc/source/cli/plugin-commands/sahara.rst Normal file
View File

@ -0,0 +1,5 @@
sahara
------
.. list-plugins:: openstack.data_processing.v1
:detailed:

5
doc/source/cli/plugin-commands/searchlight.rst Normal file
View File

@ -0,0 +1,5 @@
searchlight
-----------
.. list-plugins:: openstack.search.v1
:detailed:

5
doc/source/cli/plugin-commands/senlin.rst Normal file
View File

@ -0,0 +1,5 @@
senlin
------
.. list-plugins:: openstack.clustering.v1
:detailed:

5
doc/source/cli/plugin-commands/trove.rst Normal file
View File

@ -0,0 +1,5 @@
trove
-----
.. list-plugins:: openstack.database.v1
:detailed:

5
doc/source/cli/plugin-commands/zaqar.rst Normal file
View File

@ -0,0 +1,5 @@
zaqar
-----
.. list-plugins:: openstack.messaging.v2
:detailed:

5
doc/source/cli/plugin-commands/zun.rst Normal file
View File

@ -0,0 +1,5 @@
zun
---
.. list-plugins:: openstack.container.v1
:detailed: