diff options
| author | Eric Fried <openstack@fried.cc> | 2019-10-28 17:27:38 -0500 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-11-01 14:24:30 -0500 |
| commit | cd6c285cc6c2274e6b42cc452ba4a61a3487ca23 (patch) | |
| tree | 334eddf792c9287511a8d419e82c2e6777fd63b2 /doc/source/cli/command-objects/address-scope.rst | |
| parent | 61ad83b57580c76a1c448e03064c4df6bcc01e87 (diff) | |
| download | python-openstackclient-cd6c285cc6c2274e6b42cc452ba4a61a3487ca23.tar.gz | |
neutron: autogenerate docs
$namespace = openstack.network.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.
This one turned out to be quite involved, because we support both
neutron and nova-network. When running in a real cloud, the command
classes detect whether the neutron service is present, assume
nova-network if that service is not found, and only add parser options
relevant to the detected service. But the docs need to present both sets
of options. This was easy enough when they were hardcoded, but required
a bit of additional infrastructure for generated docs.
Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
Diffstat (limited to 'doc/source/cli/command-objects/address-scope.rst')
| -rw-r--r-- | doc/source/cli/command-objects/address-scope.rst | 142 |
1 files changed, 2 insertions, 140 deletions
diff --git a/doc/source/cli/command-objects/address-scope.rst b/doc/source/cli/command-objects/address-scope.rst index 9155d09e..38141d5c 100644 --- a/doc/source/cli/command-objects/address-scope.rst +++ b/doc/source/cli/command-objects/address-scope.rst @@ -7,143 +7,5 @@ to a given project and may be shared between projects. Network v2 -address scope create --------------------- - -Create new address scope - -.. program:: address scope create -.. code:: bash - - openstack address scope create - [--project <project> [--project-domain <project-domain>]] - [--ip-version <ip-version>] - [--share | --no-share] - <name> - -.. option:: --project <project> - - Owner's project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --ip-version <ip-version> - - IP version (4 or 6, default is 4) - -.. option:: --share - - Share the address scope between projects - -.. option:: --no-share - - Do not share the address scope between projects (default) - -.. _address_scope_create-name: -.. describe:: <name> - - New address scope name - -address scope delete --------------------- - -Delete address scope(s) - -.. program:: address scope delete -.. code:: bash - - openstack address scope delete - <address-scope> [<address-scope> ...] - -.. _address_scope_delete-address-scope: -.. describe:: <address-scope> - - Address scope(s) to delete (name or ID) - -address scope list ------------------- - -List address scopes - -.. program:: address scope list -.. code:: bash - - openstack address scope list - [--name <name>] - [--ip-version <ip-version>] - [--project <project> [--project-domain <project-domain>]] - [--share | --no-share] - -.. option:: --name <name> - - List only address scopes of given name in output - -.. option:: --ip-version <ip-version> - - List address scopes of given IP version networks (4 or 6) - -.. option:: --project <project> - - List address scopes according to their project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --share - - List address scopes shared between projects - -.. option:: --no-share - - List address scopes not shared between projects - -address scope set ------------------ - -Set address scope properties - -.. program:: address scope set -.. code:: bash - - openstack address scope set - [--name <name>] - [--share | --no-share] - <address-scope> - -.. option:: --name <name> - - Set address scope name - -.. option:: --share - - Share the address scope between projects - -.. option:: --no-share - - Do not share the address scope between projects - -.. _address_scope_set-address-scope: -.. describe:: <address-scope> - - Address scope to modify (name or ID) - -address scope show ------------------- - -Display address scope details - -.. program:: address scope show -.. code:: bash - - openstack address scope show - <address-scope> - -.. _address_scope_show-address-scope: -.. describe:: <address-scope> - - Address scope to display (name or ID) +.. autoprogram-cliff:: openstack.network.v2 + :command: address scope * |