summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/floating-ip-pool.rst
diff options
context:
space:
mode:
authorEric Fried <openstack@fried.cc>2019-10-28 17:27:38 -0500
committerEric Fried <openstack@fried.cc>2019-11-01 14:24:30 -0500
commitcd6c285cc6c2274e6b42cc452ba4a61a3487ca23 (patch)
tree334eddf792c9287511a8d419e82c2e6777fd63b2 /doc/source/cli/command-objects/floating-ip-pool.rst
parent61ad83b57580c76a1c448e03064c4df6bcc01e87 (diff)
downloadpython-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/floating-ip-pool.rst')
-rw-r--r--doc/source/cli/command-objects/floating-ip-pool.rst11
1 files changed, 2 insertions, 9 deletions
diff --git a/doc/source/cli/command-objects/floating-ip-pool.rst b/doc/source/cli/command-objects/floating-ip-pool.rst
index 5c8f3aa1..ab6f83a9 100644
--- a/doc/source/cli/command-objects/floating-ip-pool.rst
+++ b/doc/source/cli/command-objects/floating-ip-pool.rst
@@ -4,12 +4,5 @@ floating ip pool
Network v2
-floating ip pool list
----------------------
-
-List pools of floating IP addresses
-
-.. program:: floating ip pool list
-.. code:: bash
-
- openstack floating ip pool list
+.. autoprogram-cliff:: openstack.network.v2
+ :command: floating ip pool *