diff options
| author | Michael Johnson <johnsomor@gmail.com> | 2017-08-23 11:31:42 -0700 |
|---|---|---|
| committer | Michael Johnson <johnsomor@gmail.com> | 2017-08-23 13:20:18 -0700 |
| commit | bc2a3aaefb7280b0cc88f27982367988d0be13b8 (patch) | |
| tree | 9b06a914186876edceb8dae59371741490a1c1c2 /doc/source | |
| parent | 14b546328929ca3b130ecda8bbaae004c2de4687 (diff) | |
| download | python-ironicclient-bc2a3aaefb7280b0cc88f27982367988d0be13b8.tar.gz | |
Add auto-generated CLI reference
The Ironic OSC plugin CLI was not being fully documented.
This patch enables an auto-generated CLI reference for the OSC plugin.
Note: There is a formatting issue with required arguments that include a
hyphen. This has been opened as a bug [1].
[1] https://bugs.launchpad.net/python-cliff/+bug/1712612
Closes-Bug: #1712099
Change-Id: I541214f3b3bab9af0ae79c8055dfa1f151560b21
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/cli/osc/v1/index.rst | 40 | ||||
| -rw-r--r-- | doc/source/cli/osc_plugin_cli.rst | 8 | ||||
| -rw-r--r-- | doc/source/conf.py | 3 |
3 files changed, 51 insertions, 0 deletions
diff --git a/doc/source/cli/osc/v1/index.rst b/doc/source/cli/osc/v1/index.rst new file mode 100644 index 0000000..c0aee31 --- /dev/null +++ b/doc/source/cli/osc/v1/index.rst @@ -0,0 +1,40 @@ +Command Reference +================= + +List of released CLI commands available in openstack client. These commands +can be referenced by doing ``openstack help baremetal``. + +================= +baremetal chassis +================= + +.. autoprogram-cliff:: openstack.baremetal.v1 + :command: baremetal chassis * + +================ +baremetal driver +================ + +.. autoprogram-cliff:: openstack.baremetal.v1 + :command: baremetal driver * + +============== +baremetal node +============== + +.. autoprogram-cliff:: openstack.baremetal.v1 + :command: baremetal node * + +============== +baremetal port +============== + +.. autoprogram-cliff:: openstack.baremetal.v1 + :command: baremetal port * + +================ +baremetal volume +================ + +.. autoprogram-cliff:: openstack.baremetal.v1 + :command: baremetal volume * diff --git a/doc/source/cli/osc_plugin_cli.rst b/doc/source/cli/osc_plugin_cli.rst index 79e7455..1775e5c 100644 --- a/doc/source/cli/osc_plugin_cli.rst +++ b/doc/source/cli/osc_plugin_cli.rst @@ -83,3 +83,11 @@ The baremetal API version can be specified via: * or optional command line argument --os-baremetal-api-version:: $ openstack baremetal port group list --os-baremetal-api-version 1.25 + +Command Reference +================= +.. toctree:: + :glob: + :maxdepth: 3 + + osc/v1/* diff --git a/doc/source/conf.py b/doc/source/conf.py index 26cedab..270cc79 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -5,6 +5,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'openstackdocstheme', + 'cliff.sphinxext', ] # openstackdocstheme options @@ -74,3 +75,5 @@ latex_documents = [ 'manual' ), ] + +autoprogram_cliff_application = 'openstack' |