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, 2 insertions, 399 deletions

diff --git a/doc/source/cli/command-objects/router.rst b/doc/source/cli/command-objects/router.rst
index 9c9364bc..6e8e05d7 100644
--- a/doc/source/cli/command-objects/router.rst
+++ b/doc/source/cli/command-objects/router.rst
@@ -8,402 +8,5 @@ network access for servers on project networks.
 
 Network v2
 
-router add port
----------------
-
-Add a port to a router
-
-.. program:: router add port
-.. code:: bash
-
-    openstack router add port
-        <router>
-        <port>
-
-.. _router_add_port:
-
-.. describe:: <router>
-
-    Router to which port will be added (name or ID)
-
-.. describe:: <port>
-
-    Port to be added (name or ID)
-
-router add subnet
------------------
-
-Add a subnet to a router
-
-.. program:: router add subnet
-.. code:: bash
-
-    openstack router add subnet
-        <router>
-        <subnet>
-
-.. _router_add_subnet:
-
-.. describe:: <router>
-
-    Router to which subnet will be added (name or ID)
-
-.. describe:: <subnet>
-
-    Subnet to be added (name or ID)
-
-router create
--------------
-
-Create new router
-
-.. program:: router create
-.. code:: bash
-
-    openstack router create
-        [--project <project> [--project-domain <project-domain>]]
-        [--enable | --disable]
-        [--distributed | --centralized]
-        [--ha | --no-ha]
-        [--description <description>]
-        [--availability-zone-hint <availability-zone>]
-        [--tag <tag> | --no-tag]
-        <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:: --enable
-
-    Enable router (default)
-
-.. option:: --disable
-
-    Disable router
-
-.. option:: --distributed
-
-    Create a distributed router
-
-    The default router type (distributed vs centralized) is determined by a
-    configuration setting in the OpenStack deployment.  Since we are unable
-    to know that default wihtout attempting to actually create a router it
-    is suggested to use either :option:`--distributed` or :option:`--centralized`
-    in situations where multiple cloud deployments may be used.
-
-.. option:: --centralized
-
-    Create a centralized router
-
-    See the note in :option:`--distributed` regarding the default used when
-    creating a new router.
-
-.. option:: --ha
-
-    Create a highly available router
-
-.. option:: --no-ha
-
-    Create a legacy router
-
-.. option:: --description <description>
-
-    Set router description
-
-.. option:: --availability-zone-hint <availability-zone>
-
-    Availability Zone in which to create this router
-    (Router Availability Zone extension required,
-    repeat option to set multiple availability zones)
-
-.. option:: --tag <tag>
-
-    Tag to be added to the router (repeat option to set multiple tags)
-
-.. option:: --no-tag
-
-    No tags associated with the router
-
-.. _router_create-name:
-.. describe:: <name>
-
-    New router name
-
-router delete
--------------
-
-Delete router(s)
-
-.. program:: router delete
-.. code:: bash
-
-    openstack router delete
-        <router> [<router> ...]
-
-.. _router_delete-router:
-.. describe:: <router>
-
-    Router(s) to delete (name or ID)
-
-router list
------------
-
-List routers
-
-.. program:: router list
-.. code:: bash
-
-    openstack router list
-        [--name <name>]
-        [--enable | --disable]
-        [--long]
-        [--project <project> [--project-domain <project-domain>]]
-        [--agent <agent-id>]
-        [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]]
-        [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
-
-.. option:: --agent <agent-id>
-
-    List routers hosted by an agent (ID only)
-
-.. option:: --long
-
-    List additional fields in output
-
-.. option:: --name <name>
-
-    List routers according to their name
-
-.. option:: --enable
-
-    List enabled routers
-
-.. option:: --disable
-
-    List disabled routers
-
-.. option:: --project <project>
-
-    List routers 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:: --tags <tag>[,<tag>,...]
-
-    List routers which have all given tag(s)
-
-.. option:: --any-tags <tag>[,<tag>,...]
-
-    List routers which have any given tag(s)
-
-.. option:: --not-tags <tag>[,<tag>,...]
-
-    Exclude routers which have all given tag(s)
-
-.. option:: --not-any-tags <tag>[,<tag>,...]
-
-    Exclude routers which have any given tag(s)
-
-router remove port
-------------------
-
-Remove a port from a router
-
-.. program:: router remove port
-.. code:: bash
-
-    openstack router remove port
-        <router>
-        <port>
-
-.. _router_remove_port:
-
-.. describe:: <router>
-
-    Router from which port will be removed (name or ID)
-
-.. describe:: <port>
-
-    Port to be removed and deleted (name or ID)
-
-router remove subnet
---------------------
-
-Remove a subnet from a router
-
-.. program:: router remove subnet
-.. code:: bash
-
-    openstack router remove subnet
-        <router>
-        <subnet>
-
-.. _router_remove_subnet:
-
-.. describe:: <router>
-
-    Router from which subnet will be removed (name or ID)
-
-.. describe:: <subnet>
-
-    Subnet to be removed (name or ID)
-
-router set
-----------
-
-Set router properties
-
-.. program:: router set
-.. code:: bash
-
-    openstack router set
-        [--name <name>]
-        [--enable | --disable]
-        [--distributed | --centralized]
-        [--description <description>]
-        [--route destination=<subnet>,gateway=<ip-address> | --no-route]
-        [--ha | --no-ha]
-        [--external-gateway <network> [--enable-snat|--disable-snat] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]]
-        [--tag <tag>] [--no-tag]
-        <router>
-
-.. option:: --name <name>
-
-    Set router name
-
-.. option:: --enable
-
-    Enable router
-
-.. option:: --disable
-
-    Disable router
-
-.. option:: --distributed
-
-    Set router to distributed mode (disabled router only)
-
-.. option:: --centralized
-
-    Set router to centralized mode (disabled router only)
-
-.. option:: --description <description>
-
-    Set router description
-
-.. option:: --route destination=<subnet>,gateway=<ip-address>
-
-    Routes associated with the router
-    destination: destination subnet (in CIDR notation)
-    gateway: nexthop IP address
-    (repeat option to set multiple routes)
-
-.. option:: --no-route
-
-    Clear routes associated with the router.
-    Specify both --route and --no-route to overwrite
-    current value of route.
-
-.. option:: --ha
-
-    Set the router as highly available (disabled router only)
-
-.. option:: --no-ha
-
-    Clear high availablability attribute of the router (disabled router only)
-
-.. option:: --external-gateway <network>
-
-    External Network used as router's gateway (name or ID)
-
-.. option:: --enable-snat
-
-    Enable Source NAT on external gateway
-
-.. option:: --disable-snat
-
-    Disable Source NAT on external gateway
-
-.. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
-
-    Desired IP and/or subnet (name or ID) on external gateway:
-    subnet=<subnet>,ip-address=<ip-address>
-    (repeat option to set multiple fixed IP addresses)
-
-.. option:: --tag <tag>
-
-    Tag to be added to the router (repeat option to set multiple tags)
-
-.. option:: --no-tag
-
-    Clear tags associated with the router. Specify both --tag
-    and --no-tag to overwrite current tags
-
-.. _router_set-router:
-.. describe:: <router>
-
-    Router to modify (name or ID)
-
-router show
------------
-
-Display router details
-
-.. program:: router show
-.. code:: bash
-
-    openstack router show
-        <router>
-
-.. _router_show-router:
-.. describe:: <router>
-
-    Router to display (name or ID)
-
-router unset
-------------
-
-Unset router properties
-
-.. program:: router unset
-.. code:: bash
-
-    openstack router unset
-        [--route destination=<subnet>,gateway=<ip-address>]
-        [--external-gateway]
-        [--tag <tag> | --all-tag]
-        <router>
-
-.. option:: --route destination=<subnet>,gateway=<ip-address>
-
-    Routes to be removed from the router
-    destination: destination subnet (in CIDR notation)
-    gateway: nexthop IP address
-    (repeat option to unset multiple routes)
-
-.. option:: --external-gateway
-
-    Remove external gateway information from the router
-
-.. option:: --tag <tag>
-
-    Tag to be removed from the router
-    (repeat option to remove multiple tags)
-
-.. option:: --all-tag
-
-    Clear all tags associated with the router
-
-.. _router_unset-router:
-.. describe:: <router>
-
-    Router to modify (name or ID)
+.. autoprogram-cliff:: openstack.network.v2
+   :command: router *