summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/hypervisor.rst
diff options
context:
space:
mode:
authorEric Fried <openstack@fried.cc>2019-11-04 16:02:31 -0600
committerEric Fried <openstack@fried.cc>2019-11-05 07:09:05 -0600
commitc6266b5ab22b911ae7e0ca5077d0c04a23dabca9 (patch)
tree8e2f4ff670b4b272184ecc877cd9838b5ad4873b /doc/source/cli/command-objects/hypervisor.rst
parentda56b8f4cf15cc5a77249b680dd0c4d05137be9a (diff)
downloadpython-openstackclient-c6266b5ab22b911ae7e0ca5077d0c04a23dabca9.tar.gz
compute: autogenerate docs
$namespace = openstack.compute.v2 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. Many of these were already being generated. Some were missing a few sub-subcommands, so those are added. Change-Id: I1aa4b2655bafd2f6a5d83b658742f65d180eb128
Diffstat (limited to 'doc/source/cli/command-objects/hypervisor.rst')
-rw-r--r--doc/source/cli/command-objects/hypervisor.rst39
1 files changed, 6 insertions, 33 deletions
diff --git a/doc/source/cli/command-objects/hypervisor.rst b/doc/source/cli/command-objects/hypervisor.rst
index 9db384a2..9ae82bf1 100644
--- a/doc/source/cli/command-objects/hypervisor.rst
+++ b/doc/source/cli/command-objects/hypervisor.rst
@@ -4,38 +4,11 @@ hypervisor
Compute v2
-hypervisor list
----------------
+.. NOTE(efried): have to list these out one by one; 'hypervisor *' pulls in
+ ... stats.
-List hypervisors
+.. autoprogram-cliff:: openstack.compute.v2
+ :command: hypervisor list
-.. program:: hypervisor list
-.. code:: bash
-
- openstack hypervisor list
- [--matching <hostname>]
- [--long]
-
-.. option:: --matching <hostname>
-
- Filter hypervisors using <hostname> substring
-
-.. option:: --long
-
- List additional fields in output
-
-hypervisor show
----------------
-
-Display hypervisor details
-
-.. program:: hypervisor show
-.. code:: bash
-
- openstack hypervisor show
- <hypervisor>
-
-.. _hypervisor_show-flavor:
-.. describe:: <hypervisor>
-
- Hypervisor to display (name or ID)
+.. autoprogram-cliff:: openstack.compute.v2
+ :command: hypervisor show