Merge "autodocument commands from plugins using stevedore.sphinxext"

doc/source/commands.rst

@@ -126,7 +126,8 @@ Plugin Objects
 --------------
 
 The following are known `Objects` used by OpenStack :doc:`plugins`. These are
-listed here to avoid name conflicts when creating new plugins.
+listed here to avoid name conflicts when creating new plugins. For a complete
+list check out :doc:`plugin-commands`.
 
 * ``baremetal``: (**Baremetal (Ironic)**)
 * ``congress datasource``: (**Policy (Congress)**)

doc/source/conf.py

@@ -38,6 +38,7 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.todo',
               'oslosphinx',
               'ext.apidoc',
+              'stevedore.sphinxext',
               ]
 
 # Add any paths that contain templates here, relative to this directory.

doc/source/index.rst

@@ -16,6 +16,7 @@ User Documentation
    commands
    configuration
    plugins
+   plugin-commands
    authentication
    interactive
    humaninterfaceguide

doc/source/plugin-commands.rst

@@ -0,0 +1,32 @@
+=================
+ Plugin Commands
+=================
+
+.. list-plugins:: openstack.cli.extension
+
+.. list-plugins:: openstack.key_manager.v1
+   :detailed:
+
+.. list-plugins:: openstack.baremetal.v1
+   :detailed:
+
+.. list-plugins:: openstack.congressclient.v1
+   :detailed:
+
+.. list-plugins:: openstack.workflow_engine.v2
+   :detailed:
+
+.. list-plugins:: openstack.data_processing.v1
+   :detailed:
+
+.. list-plugins:: openstack.dns.v1
+   :detailed:
+
+.. list-plugins:: openstack.management.v1
+   :detailed:
+
+.. list-plugins:: openstack.messaging.v1
+   :detailed:
+
+.. list-plugins:: openstack.orchestration.v1
+   :detailed:

test-requirements.txt

@@ -16,3 +16,14 @@ testrepository>=0.0.18
 testtools>=1.4.0
 WebOb>=1.2.3
 tempest-lib>=0.10.0
+
+# Install these to generate sphinx autodocs
+python-barbicanclient>=3.3.0
+python-congressclient>=1.0.0
+python-designateclient>=1.5.0
+python-heatclient>=0.6.0
+python-ironicclient>=0.8.0
+python-mistralclient>=1.0.0
+python-saharaclient>=0.10.0
+python-tuskarclient>=0.1.17
+python-zaqarclient>=0.3.0