Split plugin docs per project

Eric Fried · Eric Fried · commit 85c83530ee63 · 2019-10-21T17:44:15.000-05:00
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
diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess
@@ -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
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
@@ -8,7 +8,7 @@
    Manual Page <man/openstack>
    command-list
    commands
-   plugin-commands
+   plugin-commands/index
    authentication
    interactive
    decoder
diff --git a/doc/source/cli/plugin-commands.rst b/doc/source/cli/plugin-commands.rst
diff --git a/doc/source/cli/plugin-commands/aodh.rst b/doc/source/cli/plugin-commands/aodh.rst
@@ -0,0 +1,5 @@
+aodh
+----
+
+.. list-plugins:: openstack.alarming.v2
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/barbican.rst b/doc/source/cli/plugin-commands/barbican.rst
@@ -0,0 +1,5 @@
+barbican
+--------
+
+.. list-plugins:: openstack.key_manager.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/congress.rst b/doc/source/cli/plugin-commands/congress.rst
@@ -0,0 +1,5 @@
+congress
+--------
+
+.. list-plugins:: openstack.congressclient.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/designate.rst b/doc/source/cli/plugin-commands/designate.rst
@@ -0,0 +1,5 @@
+designate
+---------
+
+.. list-plugins:: openstack.dns.v2
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/gnocchi.rst b/doc/source/cli/plugin-commands/gnocchi.rst
@@ -0,0 +1,5 @@
+gnocchi
+-------
+
+.. list-plugins:: openstack.metric.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/heat.rst b/doc/source/cli/plugin-commands/heat.rst
@@ -0,0 +1,5 @@
+heat
+----
+
+.. list-plugins:: openstack.orchestration.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/index.rst b/doc/source/cli/plugin-commands/index.rst
@@ -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:
diff --git a/doc/source/cli/plugin-commands/ironic-inspector.rst b/doc/source/cli/plugin-commands/ironic-inspector.rst
@@ -0,0 +1,5 @@
+ironic-inspector
+----------------
+
+.. list-plugins:: openstack.baremetal_introspection.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/ironic.rst b/doc/source/cli/plugin-commands/ironic.rst
@@ -0,0 +1,5 @@
+ironic
+------
+
+.. list-plugins:: openstack.baremetal.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/karbor.rst b/doc/source/cli/plugin-commands/karbor.rst
@@ -0,0 +1,5 @@
+karbor
+------
+
+.. list-plugins:: openstack.data_protection.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/mistral.rst b/doc/source/cli/plugin-commands/mistral.rst
@@ -0,0 +1,5 @@
+mistral
+-------
+
+.. list-plugins:: openstack.workflow_engine.v2
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/neutron.rst b/doc/source/cli/plugin-commands/neutron.rst
@@ -0,0 +1,5 @@
+neutron
+-------
+
+.. list-plugins:: openstack.neutronclient.v2
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/octavia.rst b/doc/source/cli/plugin-commands/octavia.rst
@@ -0,0 +1,5 @@
+octavia
+-------
+
+.. list-plugins:: openstack.load_balancer.v2
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/placement.rst b/doc/source/cli/plugin-commands/placement.rst
@@ -0,0 +1,5 @@
+placement
+---------
+
+.. list-plugins:: openstack.placement.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/rsd.rst b/doc/source/cli/plugin-commands/rsd.rst
@@ -0,0 +1,5 @@
+rsd
+---
+
+.. list-plugins:: openstack.rsd.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/sahara.rst b/doc/source/cli/plugin-commands/sahara.rst
@@ -0,0 +1,5 @@
+sahara
+------
+
+.. list-plugins:: openstack.data_processing.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/searchlight.rst b/doc/source/cli/plugin-commands/searchlight.rst
@@ -0,0 +1,5 @@
+searchlight
+-----------
+
+.. list-plugins:: openstack.search.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/senlin.rst b/doc/source/cli/plugin-commands/senlin.rst
@@ -0,0 +1,5 @@
+senlin
+------
+
+.. list-plugins:: openstack.clustering.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/trove.rst b/doc/source/cli/plugin-commands/trove.rst
@@ -0,0 +1,5 @@
+trove
+-----
+
+.. list-plugins:: openstack.database.v1
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/zaqar.rst b/doc/source/cli/plugin-commands/zaqar.rst
@@ -0,0 +1,5 @@
+zaqar
+-----
+
+.. list-plugins:: openstack.messaging.v2
+   :detailed:
diff --git a/doc/source/cli/plugin-commands/zun.rst b/doc/source/cli/plugin-commands/zun.rst
@@ -0,0 +1,5 @@
+zun
+---
+
+.. list-plugins:: openstack.container.v1
+   :detailed:

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +aodh
 +----
++
 +.. list-plugins:: openstack.alarming.v2
 +   :detailed: