Skip to content

Commit 3fd63c0

Browse files
author
Eric Fried
committed
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
1 parent 85c8353 commit 3fd63c0

File tree

20 files changed

+24
-32
lines changed

20 files changed

+24
-32
lines changed
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
aodh
22
----
33

4-
.. list-plugins:: openstack.alarming.v2
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.alarming.v2
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
barbican
22
--------
33

4-
.. list-plugins:: openstack.key_manager.v1
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.key_manager.v1
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
congress
22
--------
33

4-
.. list-plugins:: openstack.congressclient.v1
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.congressclient.v1
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
designate
22
---------
33

4-
.. list-plugins:: openstack.dns.v2
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.dns.v2
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
gnocchi
22
-------
33

4-
.. list-plugins:: openstack.metric.v1
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.metric.v1
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
heat
22
----
33

4-
.. list-plugins:: openstack.orchestration.v1
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.orchestration.v1
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
ironic-inspector
22
----------------
33

4-
.. list-plugins:: openstack.baremetal_introspection.v1
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.baremetal_introspection.v1
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
ironic
22
------
33

4-
.. list-plugins:: openstack.baremetal.v1
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.baremetal.v1
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
karbor
22
------
33

4-
.. list-plugins:: openstack.data_protection.v1
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.data_protection.v1
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
mistral
22
-------
33

4-
.. list-plugins:: openstack.workflow_engine.v2
5-
:detailed:
4+
.. autoprogram-cliff:: openstack.workflow_engine.v2

0 commit comments

Comments
 (0)