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

1 files changed, 14 insertions, 289 deletions

diff --git a/doc/source/cli/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst
index d122ccbe..c781a1ed 100644
--- a/doc/source/cli/command-objects/floating-ip.rst
+++ b/doc/source/cli/command-objects/floating-ip.rst
@@ -4,298 +4,23 @@ floating ip
 
 Network v2
 
-floating ip create
-------------------
+.. NOTE(efried): have to list these out one by one; 'floating ip' pulls in
+                 ... pool and ... port forwarding.
 
-Create floating IP
+.. autoprogram-cliff:: openstack.network.v2
+   :command: floating ip create
 
-.. program:: floating ip create
-.. code:: bash
+.. autoprogram-cliff:: openstack.network.v2
+   :command: floating ip delete
 
-    openstack floating ip create
-        [--subnet <subnet>]
-        [--port <port>]
-        [--floating-ip-address <ip-address>]
-        [--fixed-ip-address <ip-address>]
-        [--description <description>]
-        [--qos-policy <qos-policy>]
-        [--project <project> [--project-domain <project-domain>]]
-        [--tag <tag> | --no-tag]
-        [--dns-domain <dns-domain>]
-        [--dns-name <dns-name>]
-        <network>
+.. autoprogram-cliff:: openstack.network.v2
+   :command: floating ip list
 
-.. option:: --subnet <subnet>
+.. autoprogram-cliff:: openstack.network.v2
+   :command: floating ip set
 
-    Subnet on which you want to create the floating IP (name or ID)
-    *Network version 2 only*
+.. autoprogram-cliff:: openstack.network.v2
+   :command: floating ip show
 
-.. option:: --port <port>
-
-    Port to be associated with the floating IP (name or ID)
-    *Network version 2 only*
-
-.. option:: --floating-ip-address <ip-address>
-
-    Floating IP address
-    *Network version 2 only*
-
-.. option:: --fixed-ip-address <ip-address>
-
-    Fixed IP address mapped to the floating IP
-    *Network version 2 only*
-
-.. option:: --description <description>
-
-    Set floating IP description
-    *Network version 2 only*
-
-.. option:: --qos-policy <qos-policy>
-
-    QoS policy to attach to the floating IP (name or ID)
-
-    *Network version 2 only*
-
-.. option:: --project <project>
-
-    Owner's project (name or ID)
-
-    *Network version 2 only*
-
-.. option:: --project-domain <project-domain>
-
-    Domain the project belongs to (name or ID).
-    This can be used in case collisions between project names exist.
-
-    *Network version 2 only*
-
-.. option:: --tag <tag>
-
-    Tag to be added to the floating IP (repeat option to set multiple tags)
-
-    *Network version 2 only*
-
-.. option:: --no-tag
-
-    No tags associated with the floating IP
-
-    *Network version 2 only*
-
-.. option:: --dns-domain <dns-domain>
-
-    Set DNS domain for this floating IP (requires DNS integration extension).
-
-.. option:: --dns-name <dns-name>
-
-    Set DNS name for this floating IP (requires DNS integration extension).
-
-.. describe:: <network>
-
-    Network to allocate floating IP from (name or ID)
-
-floating ip delete
-------------------
-
-Delete floating IP(s)
-
-.. program:: floating ip delete
-.. code:: bash
-
-    openstack floating ip delete <floating-ip> [<floating-ip> ...]
-
-.. describe:: <floating-ip>
-
-    Floating IP(s) to delete (IP address or ID)
-
-floating ip list
-----------------
-
-List floating IP(s)
-
-.. program:: floating ip list
-.. code:: bash
-
-    openstack floating ip list
-        [--network <network>]
-        [--port <port>]
-        [--fixed-ip-address <ip-address>]
-        [--long]
-        [--status <status>]
-        [--project <project> [--project-domain <project-domain>]]
-        [--router <router>]
-        [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]]
-        [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
-
-.. option:: --network <network>
-
-    List floating IP(s) according to given network (name or ID)
-
-    *Network version 2 only*
-
-.. option:: --port <port>
-
-    List floating IP(s) according to given port (name or ID)
-
-    *Network version 2 only*
-
-.. option:: --fixed-ip-address <ip-address>
-
-    List floating IP(s) according to given fixed IP address
-
-    *Network version 2 only*
-
-.. option:: --floating-ip-address <ip-address>
-
-    List floating IP(s) according to given floating IP address
-
-    *Network version 2 only*
-
-.. option:: --long
-
-    List additional fields in output
-
-    *Network version 2 only*
-
-.. option:: --status <status>
-
-    List floating IP(s) according to given status ('ACTIVE', 'DOWN')
-
-    *Network version 2 only*
-
-.. option:: --project <project>
-
-    List floating IP(s) according to given project (name or ID)
-
-    *Network version 2 only*
-
-.. option:: --project-domain <project-domain>
-
-    Domain the project belongs to (name or ID). This can
-    be used in case collisions between project names exist.
-
-    *Network version 2 only*
-
-.. option:: --router <router>
-
-    List floating IP(s) according to given router (name or ID)
-
-    *Network version 2 only*
-
-.. option:: --tags <tag>[,<tag>,...]
-
-    List floating IP(s) which have all given tag(s)
-
-    *Network version 2 only*
-
-.. option:: --any-tags <tag>[,<tag>,...]
-
-    List floating IP(s) which have any given tag(s)
-
-    *Network version 2 only*
-
-.. option:: --not-tags <tag>[,<tag>,...]
-
-    Exclude floating IP(s) which have all given tag(s)
-
-    *Network version 2 only*
-
-.. option:: --not-any-tags <tag>[,<tag>,...]
-
-    Exclude floating IP(s) which have any given tag(s)
-
-    *Network version 2 only*
-
-floating ip set
----------------
-
-Set floating IP properties
-
-.. program:: floating ip set
-.. code:: bash
-
-    openstack floating ip set
-        [--port <port>]
-        [--fixed-ip-address <ip-address>]
-        [--qos-policy <qos-policy> | --no-qos-policy]
-        [--tag <tag>] [--no-tag]
-        <floating-ip>
-
-.. option:: --port <port>
-
-    Associate the floating IP with port (name or ID)
-
-.. option:: --fixed-ip-address <ip-address>
-
-    Fixed IP of the port (required only if port has multiple IPs)
-
-.. option:: --qos-policy <qos-policy>
-
-    Attach QoS policy to the floating IP (name or ID)
-
-.. option:: --no-qos-policy
-
-    Remove the QoS policy attached to the floating IP
-
-.. option:: --tag <tag>
-
-    Tag to be added to the floating IP (repeat option to set multiple tags)
-
-.. option:: --no-tag
-
-    Clear tags associated with the floating IP. Specify both --tag
-    and --no-tag to overwrite current tags
-
-.. _floating_ip_set-floating-ip:
-.. describe:: <floating-ip>
-
-    Floating IP to associate (IP address or ID)
-
-floating ip show
-----------------
-
-Display floating IP details
-
-.. program:: floating ip show
-.. code:: bash
-
-    openstack floating ip show <floating-ip>
-
-.. describe:: <floating-ip>
-
-    Floating IP to display (IP address or ID)
-
-floating ip unset
------------------
-
-Unset floating IP Properties
-
-.. program:: floating ip unset
-.. code:: bash
-
-    openstack floating ip unset
-        [--port]
-        [--qos-policy]
-        [--tag <tag> | --all-tag]
-        <floating-ip>
-
-.. option:: --port
-
-    Disassociate any port associated with the floating IP
-
-.. option:: --qos-policy
-
-    Remove the QoS policy attached to the floating IP
-
-.. option:: --tag <tag>
-
-    Tag to be removed from the floating IP
-    (repeat option to remove multiple tags)
-
-.. option:: --all-tag
-
-    Clear all tags associated with the floating IP
-
-.. _floating_ip_unset-floating-ip:
-.. describe:: <floating-ip>
-
-    Floating IP to disassociate (IP address or ID)
+.. autoprogram-cliff:: openstack.network.v2
+   :command: floating ip unset