diff options
| author | Eric Fried <openstack@fried.cc> | 2019-10-21 17:31:04 -0500 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-10-21 17:45:35 -0500 |
| commit | 3fd63c0021d5ddddfb0ecce5d5f38799bcb13661 (patch) | |
| tree | a5d01ded95e043eacedb39e229620e525882525e /doc/source/cli | |
| parent | 85c83530ee63e1c66bc132d4b0c97d7f2b077ee8 (diff) | |
| download | python-openstackclient-3fd63c0021d5ddddfb0ecce5d5f38799bcb13661.tar.gz | |
Produce complete content for plugin docs
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
Diffstat (limited to 'doc/source/cli')
20 files changed, 24 insertions, 32 deletions
diff --git a/doc/source/cli/plugin-commands/aodh.rst b/doc/source/cli/plugin-commands/aodh.rst index 26e7bf70..5d8b4332 100644 --- a/doc/source/cli/plugin-commands/aodh.rst +++ b/doc/source/cli/plugin-commands/aodh.rst @@ -1,5 +1,4 @@ aodh ---- -.. list-plugins:: openstack.alarming.v2 - :detailed: +.. autoprogram-cliff:: openstack.alarming.v2 diff --git a/doc/source/cli/plugin-commands/barbican.rst b/doc/source/cli/plugin-commands/barbican.rst index 21b9b554..224b274f 100644 --- a/doc/source/cli/plugin-commands/barbican.rst +++ b/doc/source/cli/plugin-commands/barbican.rst @@ -1,5 +1,4 @@ barbican -------- -.. list-plugins:: openstack.key_manager.v1 - :detailed: +.. autoprogram-cliff:: openstack.key_manager.v1 diff --git a/doc/source/cli/plugin-commands/congress.rst b/doc/source/cli/plugin-commands/congress.rst index c21e2fa3..7a1e63b7 100644 --- a/doc/source/cli/plugin-commands/congress.rst +++ b/doc/source/cli/plugin-commands/congress.rst @@ -1,5 +1,4 @@ congress -------- -.. list-plugins:: openstack.congressclient.v1 - :detailed: +.. autoprogram-cliff:: openstack.congressclient.v1 diff --git a/doc/source/cli/plugin-commands/designate.rst b/doc/source/cli/plugin-commands/designate.rst index 94071bf5..045072b2 100644 --- a/doc/source/cli/plugin-commands/designate.rst +++ b/doc/source/cli/plugin-commands/designate.rst @@ -1,5 +1,4 @@ designate --------- -.. list-plugins:: openstack.dns.v2 - :detailed: +.. autoprogram-cliff:: openstack.dns.v2 diff --git a/doc/source/cli/plugin-commands/gnocchi.rst b/doc/source/cli/plugin-commands/gnocchi.rst index a545a5ea..bbc7f6c8 100644 --- a/doc/source/cli/plugin-commands/gnocchi.rst +++ b/doc/source/cli/plugin-commands/gnocchi.rst @@ -1,5 +1,4 @@ gnocchi ------- -.. list-plugins:: openstack.metric.v1 - :detailed: +.. autoprogram-cliff:: openstack.metric.v1 diff --git a/doc/source/cli/plugin-commands/heat.rst b/doc/source/cli/plugin-commands/heat.rst index 3699aeaf..02556142 100644 --- a/doc/source/cli/plugin-commands/heat.rst +++ b/doc/source/cli/plugin-commands/heat.rst @@ -1,5 +1,4 @@ heat ---- -.. list-plugins:: openstack.orchestration.v1 - :detailed: +.. autoprogram-cliff:: openstack.orchestration.v1 diff --git a/doc/source/cli/plugin-commands/ironic-inspector.rst b/doc/source/cli/plugin-commands/ironic-inspector.rst index c1490662..7ac12618 100644 --- a/doc/source/cli/plugin-commands/ironic-inspector.rst +++ b/doc/source/cli/plugin-commands/ironic-inspector.rst @@ -1,5 +1,4 @@ ironic-inspector ---------------- -.. list-plugins:: openstack.baremetal_introspection.v1 - :detailed: +.. autoprogram-cliff:: openstack.baremetal_introspection.v1 diff --git a/doc/source/cli/plugin-commands/ironic.rst b/doc/source/cli/plugin-commands/ironic.rst index 032c57d2..d9254e9b 100644 --- a/doc/source/cli/plugin-commands/ironic.rst +++ b/doc/source/cli/plugin-commands/ironic.rst @@ -1,5 +1,4 @@ ironic ------ -.. list-plugins:: openstack.baremetal.v1 - :detailed: +.. autoprogram-cliff:: openstack.baremetal.v1 diff --git a/doc/source/cli/plugin-commands/karbor.rst b/doc/source/cli/plugin-commands/karbor.rst index aed14a66..0e28ba57 100644 --- a/doc/source/cli/plugin-commands/karbor.rst +++ b/doc/source/cli/plugin-commands/karbor.rst @@ -1,5 +1,4 @@ karbor ------ -.. list-plugins:: openstack.data_protection.v1 - :detailed: +.. autoprogram-cliff:: openstack.data_protection.v1 diff --git a/doc/source/cli/plugin-commands/mistral.rst b/doc/source/cli/plugin-commands/mistral.rst index 3facc506..5f538d29 100644 --- a/doc/source/cli/plugin-commands/mistral.rst +++ b/doc/source/cli/plugin-commands/mistral.rst @@ -1,5 +1,4 @@ mistral ------- -.. list-plugins:: openstack.workflow_engine.v2 - :detailed: +.. autoprogram-cliff:: openstack.workflow_engine.v2 diff --git a/doc/source/cli/plugin-commands/neutron.rst b/doc/source/cli/plugin-commands/neutron.rst index 6e67ae94..0167931f 100644 --- a/doc/source/cli/plugin-commands/neutron.rst +++ b/doc/source/cli/plugin-commands/neutron.rst @@ -1,5 +1,4 @@ neutron ------- -.. list-plugins:: openstack.neutronclient.v2 - :detailed: +.. autoprogram-cliff:: openstack.neutronclient.v2 diff --git a/doc/source/cli/plugin-commands/octavia.rst b/doc/source/cli/plugin-commands/octavia.rst index 5384530f..fb48f0ac 100644 --- a/doc/source/cli/plugin-commands/octavia.rst +++ b/doc/source/cli/plugin-commands/octavia.rst @@ -1,5 +1,7 @@ octavia ------- +.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed + .. 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 index 972818c7..203ecc29 100644 --- a/doc/source/cli/plugin-commands/placement.rst +++ b/doc/source/cli/plugin-commands/placement.rst @@ -1,5 +1,4 @@ placement --------- -.. list-plugins:: openstack.placement.v1 - :detailed: +.. autoprogram-cliff:: openstack.placement.v1 diff --git a/doc/source/cli/plugin-commands/rsd.rst b/doc/source/cli/plugin-commands/rsd.rst index d7962014..9436c5ae 100644 --- a/doc/source/cli/plugin-commands/rsd.rst +++ b/doc/source/cli/plugin-commands/rsd.rst @@ -1,5 +1,7 @@ rsd --- +.. TODO(efried): Cut over to autoprogram-cliff once rsd plugin docs build + .. list-plugins:: openstack.rsd.v1 :detailed: diff --git a/doc/source/cli/plugin-commands/sahara.rst b/doc/source/cli/plugin-commands/sahara.rst index 28ac8678..7c51756a 100644 --- a/doc/source/cli/plugin-commands/sahara.rst +++ b/doc/source/cli/plugin-commands/sahara.rst @@ -1,5 +1,4 @@ sahara ------ -.. list-plugins:: openstack.data_processing.v1 - :detailed: +.. autoprogram-cliff:: openstack.data_processing.v1 diff --git a/doc/source/cli/plugin-commands/searchlight.rst b/doc/source/cli/plugin-commands/searchlight.rst index fed56f09..be934aeb 100644 --- a/doc/source/cli/plugin-commands/searchlight.rst +++ b/doc/source/cli/plugin-commands/searchlight.rst @@ -1,5 +1,4 @@ searchlight ----------- -.. list-plugins:: openstack.search.v1 - :detailed: +.. autoprogram-cliff:: openstack.search.v1 diff --git a/doc/source/cli/plugin-commands/senlin.rst b/doc/source/cli/plugin-commands/senlin.rst index f5f81d9e..90929058 100644 --- a/doc/source/cli/plugin-commands/senlin.rst +++ b/doc/source/cli/plugin-commands/senlin.rst @@ -1,5 +1,4 @@ senlin ------ -.. list-plugins:: openstack.clustering.v1 - :detailed: +.. autoprogram-cliff:: openstack.clustering.v1 diff --git a/doc/source/cli/plugin-commands/trove.rst b/doc/source/cli/plugin-commands/trove.rst index b4575edd..75da2272 100644 --- a/doc/source/cli/plugin-commands/trove.rst +++ b/doc/source/cli/plugin-commands/trove.rst @@ -1,5 +1,7 @@ trove ----- +.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed + .. list-plugins:: openstack.database.v1 :detailed: diff --git a/doc/source/cli/plugin-commands/zaqar.rst b/doc/source/cli/plugin-commands/zaqar.rst index 3649a274..64151490 100644 --- a/doc/source/cli/plugin-commands/zaqar.rst +++ b/doc/source/cli/plugin-commands/zaqar.rst @@ -1,5 +1,4 @@ zaqar ----- -.. list-plugins:: openstack.messaging.v2 - :detailed: +.. autoprogram-cliff:: openstack.messaging.v2 diff --git a/doc/source/cli/plugin-commands/zun.rst b/doc/source/cli/plugin-commands/zun.rst index 56c5ff59..40480e70 100644 --- a/doc/source/cli/plugin-commands/zun.rst +++ b/doc/source/cli/plugin-commands/zun.rst @@ -1,5 +1,7 @@ zun --- +.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed + .. list-plugins:: openstack.container.v1 :detailed: |
