diff options
| author | Steve Martinelli <stevemar@ca.ibm.com> | 2015-10-16 02:08:05 -0400 |
|---|---|---|
| committer | Steve Martinelli <stevemar@ca.ibm.com> | 2015-12-01 01:23:56 -0500 |
| commit | 727792da17ac5edcfc2df7dd820dbccf318554fe (patch) | |
| tree | 64e77e761498f02a115c6fcba50d53a3f77b00c0 /doc | |
| parent | bf95d74c2d594d087c2229dd5f72174d796ef17e (diff) | |
| download | python-openstackclient-727792da17ac5edcfc2df7dd820dbccf318554fe.tar.gz | |
autodocument commands from plugins using stevedore.sphinxext
conflicting command names are a painpoint, so is manually updating
a list. let's autodocument the commands that are being use by
existing osc supporters.
Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/commands.rst | 3 | ||||
| -rw-r--r-- | doc/source/conf.py | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/plugin-commands.rst | 32 |
4 files changed, 36 insertions, 1 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst index e0742ab4..60698950 100644 --- a/doc/source/commands.rst +++ b/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)**) diff --git a/doc/source/conf.py b/doc/source/conf.py index f4434ec1..792ba40a 100644 --- a/doc/source/conf.py +++ b/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. diff --git a/doc/source/index.rst b/doc/source/index.rst index c1fbbe39..49929972 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,6 +16,7 @@ User Documentation commands configuration plugins + plugin-commands authentication interactive humaninterfaceguide diff --git a/doc/source/plugin-commands.rst b/doc/source/plugin-commands.rst new file mode 100644 index 00000000..893c4c49 --- /dev/null +++ b/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: |