openstack/python-openstackclient
Code Issues Proposed changes

Produce complete content for plugin docs

Browse Source 
Plugin documentation previously used ``.. list-plugins::`` for each
plugin command, which just produced the summary line. This might be
useful if there were also a link to the complete (per-project) docs for
the commands; but since we have the content available, we might as well
produce the complete plugin docs inline. That's going to be most useful
to a reader anyway.

So this commit switches from ``list-plugins`` to ``autoprogram-cliff``
-- except for the following, whose docs break the build when this is
done:

- octavia
- rsd
- trove
- zun

These fixups are tracked under task #37241 under this same story.

Change-Id: I2f17e203fe3da92a709884c9052c8e39ff87f4c8
Story: #1735016
Task: #37240
This commit is contained in:
Eric Fried 2019-10-21 17:31:04 -05:00
parent 85c83530ee
commit 3fd63c0021
20 changed files with 24 additions and 32 deletions

3
doc/source/cli/plugin-commands/aodh.rst

@ -1,5 +1,4 @@
aodh aodh
---- ----
.. list-plugins:: openstack.alarming.v2 .. autoprogram-cliff:: openstack.alarming.v2
:detailed:

3
doc/source/cli/plugin-commands/barbican.rst

@ -1,5 +1,4 @@
barbican barbican
-------- --------
.. list-plugins:: openstack.key_manager.v1 .. autoprogram-cliff:: openstack.key_manager.v1
:detailed:

3
doc/source/cli/plugin-commands/congress.rst

@ -1,5 +1,4 @@
congress congress
-------- --------
.. list-plugins:: openstack.congressclient.v1 .. autoprogram-cliff:: openstack.congressclient.v1
:detailed:

3
doc/source/cli/plugin-commands/designate.rst

@ -1,5 +1,4 @@
designate designate
--------- ---------
.. list-plugins:: openstack.dns.v2 .. autoprogram-cliff:: openstack.dns.v2
:detailed:

3
doc/source/cli/plugin-commands/gnocchi.rst

@ -1,5 +1,4 @@
gnocchi gnocchi
------- -------
.. list-plugins:: openstack.metric.v1 .. autoprogram-cliff:: openstack.metric.v1
:detailed:

3
doc/source/cli/plugin-commands/heat.rst

@ -1,5 +1,4 @@
heat heat
---- ----
.. list-plugins:: openstack.orchestration.v1 .. autoprogram-cliff:: openstack.orchestration.v1
:detailed:

3
doc/source/cli/plugin-commands/ironic-inspector.rst

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

3
doc/source/cli/plugin-commands/ironic.rst

@ -1,5 +1,4 @@
ironic ironic
------ ------
.. list-plugins:: openstack.baremetal.v1 .. autoprogram-cliff:: openstack.baremetal.v1
:detailed:

3
doc/source/cli/plugin-commands/karbor.rst

@ -1,5 +1,4 @@
karbor karbor
------ ------
.. list-plugins:: openstack.data_protection.v1 .. autoprogram-cliff:: openstack.data_protection.v1
:detailed:

3
doc/source/cli/plugin-commands/mistral.rst

@ -1,5 +1,4 @@
mistral mistral
------- -------
.. list-plugins:: openstack.workflow_engine.v2 .. autoprogram-cliff:: openstack.workflow_engine.v2
:detailed:

3
doc/source/cli/plugin-commands/neutron.rst

@ -1,5 +1,4 @@
neutron neutron
------- -------
.. list-plugins:: openstack.neutronclient.v2 .. autoprogram-cliff:: openstack.neutronclient.v2
:detailed:

2
doc/source/cli/plugin-commands/octavia.rst

@ -1,5 +1,7 @@
octavia octavia
------- -------
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
.. list-plugins:: openstack.load_balancer.v2 .. list-plugins:: openstack.load_balancer.v2
:detailed: :detailed:

3
doc/source/cli/plugin-commands/placement.rst

@ -1,5 +1,4 @@
placement placement
--------- ---------
.. list-plugins:: openstack.placement.v1 .. autoprogram-cliff:: openstack.placement.v1
:detailed:

2
doc/source/cli/plugin-commands/rsd.rst

@ -1,5 +1,7 @@
rsd rsd
--- ---
.. TODO(efried): Cut over to autoprogram-cliff once rsd plugin docs build
.. list-plugins:: openstack.rsd.v1 .. list-plugins:: openstack.rsd.v1
:detailed: :detailed:

3
doc/source/cli/plugin-commands/sahara.rst

@ -1,5 +1,4 @@
sahara sahara
------ ------
.. list-plugins:: openstack.data_processing.v1 .. autoprogram-cliff:: openstack.data_processing.v1
:detailed:

3
doc/source/cli/plugin-commands/searchlight.rst

@ -1,5 +1,4 @@
searchlight searchlight
----------- -----------
.. list-plugins:: openstack.search.v1 .. autoprogram-cliff:: openstack.search.v1
:detailed:

3
doc/source/cli/plugin-commands/senlin.rst

@ -1,5 +1,4 @@
senlin senlin
------ ------
.. list-plugins:: openstack.clustering.v1 .. autoprogram-cliff:: openstack.clustering.v1
:detailed:

2
doc/source/cli/plugin-commands/trove.rst

@ -1,5 +1,7 @@
trove trove
----- -----
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
.. list-plugins:: openstack.database.v1 .. list-plugins:: openstack.database.v1
:detailed: :detailed:

3
doc/source/cli/plugin-commands/zaqar.rst

@ -1,5 +1,4 @@
zaqar zaqar
----- -----
.. list-plugins:: openstack.messaging.v2 .. autoprogram-cliff:: openstack.messaging.v2
:detailed:

2
doc/source/cli/plugin-commands/zun.rst

@ -1,5 +1,7 @@
zun zun
--- ---
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
.. list-plugins:: openstack.container.v1 .. list-plugins:: openstack.container.v1
:detailed: :detailed: