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
This commit is contained in:
parent
14b5463289
commit
bc2a3aaefb
|
@ -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 *
|
|
@ -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/*
|
||||
|
|
|
@ -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'
|
||||
|
|
Loading…
Reference in New Issue