openstack/python-openstackclient
Code Issues Proposed changes

compute: autogenerate docs

Browse Source 
$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
This commit is contained in:
Eric Fried
2019-11-04 16:02:31 -06:00
parent da56b8f4cf
commit c6266b5ab2
13 changed files with 29 additions and 875 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
doc/source/cli/command-objects/host.rst
View File

@@ -6,67 +6,5 @@ Compute v2
The physical computer running a hypervisor.
host list
---------
List hosts
.. program:: host list
.. code:: bash
openstack host list
[--zone <availability-zone>]
.. option:: --zone <availability-zone>
Only return hosts in the availability zone
host set
--------
Set host properties
.. program:: host set
.. code:: bash
openstack host set
[--enable | --disable]
[--enable-maintenance | --disable-maintenance]
<host>
.. _host-set:
.. option:: --enable
Enable the host
.. option:: --disable
Disable the host
.. _maintenance-set:
.. option:: --enable-maintenance
Enable maintenance mode for the host
.. option:: --disable-maintenance
Disable maintenance mode for the host
.. describe:: <host>
Host to modify (name only)
host show
---------
Display host details
.. program:: host show
.. code:: bash
openstack host show
<host>
.. describe:: <host>
Name of host
.. autoprogram-cliff:: openstack.compute.v2
:command: host *