From 3fd63c0021d5ddddfb0ecce5d5f38799bcb13661 Mon Sep 17 00:00:00 2001
From: Eric Fried <openstack@fried.cc>
Date: Mon, 21 Oct 2019 17:31:04 -0500
Subject: [PATCH] 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
---
doc/source/cli/plugin-commands/aodh.rst | 3 +--
doc/source/cli/plugin-commands/barbican.rst | 3 +--
doc/source/cli/plugin-commands/congress.rst | 3 +--
doc/source/cli/plugin-commands/designate.rst | 3 +--
doc/source/cli/plugin-commands/gnocchi.rst | 3 +--
doc/source/cli/plugin-commands/heat.rst | 3 +--
doc/source/cli/plugin-commands/ironic-inspector.rst | 3 +--
doc/source/cli/plugin-commands/ironic.rst | 3 +--
doc/source/cli/plugin-commands/karbor.rst | 3 +--
doc/source/cli/plugin-commands/mistral.rst | 3 +--
doc/source/cli/plugin-commands/neutron.rst | 3 +--
doc/source/cli/plugin-commands/octavia.rst | 2 ++
doc/source/cli/plugin-commands/placement.rst | 3 +--
doc/source/cli/plugin-commands/rsd.rst | 2 ++
doc/source/cli/plugin-commands/sahara.rst | 3 +--
doc/source/cli/plugin-commands/searchlight.rst | 3 +--
doc/source/cli/plugin-commands/senlin.rst | 3 +--
doc/source/cli/plugin-commands/trove.rst | 2 ++
doc/source/cli/plugin-commands/zaqar.rst | 3 +--
doc/source/cli/plugin-commands/zun.rst | 2 ++
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 26e7bf70fa..5d8b4332cf 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 21b9b5545b..224b274f42 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 c21e2fa399..7a1e63b76a 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 94071bf547..045072b243 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 a545a5eab2..bbc7f6c8eb 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 3699aeaf4a..025561425a 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 c149066212..7ac12618e2 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 032c57d286..d9254e9bd3 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 aed14a6691..0e28ba5733 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 3facc506b5..5f538d29fa 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 6e67ae9480..0167931f05 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 5384530fc8..fb48f0ac7e 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 972818c768..203ecc2992 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 d7962014e5..9436c5ae75 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 28ac867828..7c51756a3a 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 fed56f0912..be934aeb36 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 f5f81d9e13..90929058f8 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 b4575edd8a..75da22726c 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 3649a274d3..6415149029 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 56c5ff59ce..40480e70ca 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: