diff options
| author | Eric Fried <openstack@fried.cc> | 2019-11-04 15:48:27 -0600 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-11-05 07:09:05 -0600 |
| commit | da56b8f4cf15cc5a77249b680dd0c4d05137be9a (patch) | |
| tree | c6e61ccfe673687ba9b38f54f9ea9b2368524f52 /doc/source/cli | |
| parent | 4c0f3bfa89dfc9f207c4f6d6dc6ded85b86fee87 (diff) | |
| download | python-openstackclient-da56b8f4cf15cc5a77249b680dd0c4d05137be9a.tar.gz | |
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
Diffstat (limited to 'doc/source/cli')
| -rw-r--r-- | doc/source/cli/command-objects/command.rst | 17 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/module.rst | 16 |
2 files changed, 4 insertions, 29 deletions
diff --git a/doc/source/cli/command-objects/command.rst b/doc/source/cli/command-objects/command.rst index 918fd959..5afc4940 100644 --- a/doc/source/cli/command-objects/command.rst +++ b/doc/source/cli/command-objects/command.rst @@ -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 * diff --git a/doc/source/cli/command-objects/module.rst b/doc/source/cli/command-objects/module.rst index f4b32e75..82269f47 100644 --- a/doc/source/cli/command-objects/module.rst +++ b/doc/source/cli/command-objects/module.rst @@ -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 * |