Skip to content

Commit da56b8f

Browse files
author
Eric Fried
committed
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
1 parent 4c0f3bf commit da56b8f

2 files changed

Lines changed: 4 additions & 29 deletions

File tree

doc/source/cli/command-objects/command.rst

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,5 @@ Internal
66

77
Installed commands in the OSC process.
88

9-
command list
10-
------------
11-
12-
List recognized commands by group
13-
14-
.. program:: command list
15-
.. code:: bash
16-
17-
openstack command list
18-
[--group <group-keyword>]
19-
20-
.. option:: --group <group-keyword>
21-
22-
Show commands filtered by a command group, for example: identity, volume,
23-
compute, image, network and other keywords
9+
.. autoprogram-cliff:: openstack.cli
10+
:command: command *

doc/source/cli/command-objects/module.rst

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,5 @@ Internal
66

77
Installed Python modules in the OSC process.
88

9-
module list
10-
-----------
11-
12-
List module versions
13-
14-
.. program:: module list
15-
.. code:: bash
16-
17-
openstack module list
18-
[--all]
19-
20-
.. option:: --all
21-
22-
Show all modules that have version information
9+
.. autoprogram-cliff:: openstack.cli
10+
:command: module *

0 commit comments

Comments
 (0)