Move to auto-generated CLI reference

This patch enables the cliff.sphinxext sphinx extension and moves our
CLI reference document to be auto-generated from the code.

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

Change-Id: I726749db4882064ede60f2bbe46e3b185ebc1f52
This commit is contained in:
Michael Johnson 2017-08-23 09:33:49 -07:00
parent c40776afad
commit 6649f7c34e
4 changed files with 39 additions and 1204 deletions

View File

@ -1,11 +1 @@
Using Octavia CLI extensions to OpenStack Client
================================================
List of released CLI commands available in openstack client. These commands
can be referenced by doing ``openstack help loadbalancer``.
.. toctree::
:glob:
:maxdepth: 2
osc/v2/*
.. include:: osc/v2/load-balancer.rst

File diff suppressed because it is too large Load Diff

View File

@ -22,7 +22,8 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'openstackdocstheme'
'openstackdocstheme',
'cliff.sphinxext'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -81,3 +82,4 @@ bug_project = 'octavia'
bug_tag = 'doc'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
autoprogram_cliff_application = 'openstack'

View File

@ -219,7 +219,7 @@ class SetLoadBalancer(command.Command):
parser.add_argument(
'loadbalancer',
metavar='<load balancer>',
metavar='<load_balancer>',
help='Name or UUID of the load balancer to update.'
)
parser.add_argument(