openstack
/
python-openstackclient
Code Issues Proposed changes

openstack.cli: autogenerate docs 

$namespace = openstack.cli

The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.

Change-Id: I1f7e9d0e5748f887dbc35200c3c8b4407da43e0b
This commit is contained in:
Eric Fried 2019-11-04 15:48:27 -06:00
parent 4c0f3bfa89
commit da56b8f4cf
2 changed files with 4 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/source/cli/command-objects/command.rst
View File

@ -6,18 +6,5 @@ Internal
Installed commands in the OSC process.
command list
------------
List recognized commands by group
.. program:: command list
.. code:: bash
openstack command list
[--group <group-keyword>]
.. option:: --group <group-keyword>
Show commands filtered by a command group, for example: identity, volume,
compute, image, network and other keywords
.. autoprogram-cliff:: openstack.cli
:command: command *

16
doc/source/cli/command-objects/module.rst
View File

@ -6,17 +6,5 @@ Internal
Installed Python modules in the OSC process.
module list
-----------
List module versions
.. program:: module list
.. code:: bash
openstack module list
[--all]
.. option:: --all
Show all modules that have version information
.. autoprogram-cliff:: openstack.cli
:command: module *