diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2017-05-30 10:32:19 +0100 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-07-21 14:48:44 +0000 |
| commit | 9cfa12df2adf9265acb82f9c5aa5f3a26dc56bb1 (patch) | |
| tree | 5b1da7e5744c07f77ddac84a9a1d8b64fc961c49 /doc/source/conf.py | |
| parent | 39673217dc88d8e7200ac090ad3d60e5b6703fdd (diff) | |
| download | python-openstackclient-9cfa12df2adf9265acb82f9c5aa5f3a26dc56bb1.tar.gz | |
Start using 'cliff.sphinxext'
'cliff', the command line library used by 'osc_lib' (and, thus,
'python-openstackclient') recently gained a Sphinx extension to
automatically document cliff commands. This allows us to use the
documentation we already have in code instead of duplicating it in the
documentation.
Introduce the use of this, starting with the 'server' commands. This
requires extending the descriptions for two commands to ensure no
information is lost.
Change-Id: If701af8d5a3f78f4b173ceb476dd0c163be4b6ca
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index fc7520fd..bd4fa730 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -34,6 +34,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'openstackdocstheme', 'stevedore.sphinxext', + 'cliff.sphinxext', ] # openstackdocstheme options @@ -269,3 +270,12 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' + + +# -- Options for cliff.sphinxext plugin --------------------------------------- + +autoprogram_cliff_application = 'openstack' + +autoprogram_cliff_ignored = [ + '--help', '--format', '--column', '--max-width', '--fit-width', + '--print-empty', '--prefix', '--noindent'] |