From cd6c285cc6c2274e6b42cc452ba4a61a3487ca23 Mon Sep 17 00:00:00 2001 From: Eric Fried Date: Mon, 28 Oct 2019 17:27:38 -0500 Subject: 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 --- .../cli/command-objects/network-meter-rule.rst | 92 +--------------------- 1 file changed, 2 insertions(+), 90 deletions(-) (limited to 'doc/source/cli/command-objects/network-meter-rule.rst') diff --git a/doc/source/cli/command-objects/network-meter-rule.rst b/doc/source/cli/command-objects/network-meter-rule.rst index 22d50aa9..616c4bc5 100644 --- a/doc/source/cli/command-objects/network-meter-rule.rst +++ b/doc/source/cli/command-objects/network-meter-rule.rst @@ -9,93 +9,5 @@ metering extension. Network v2 -network meter rule create -------------------------- - -Create meter rule - -.. program:: network meter rule create -.. code:: bash - - openstack network meter rule create - --remote-ip-prefix - [--ingress | --egress] - [--exclude | --include] - [--project [--project-domain ]] - - -.. option:: --project - - Owner's project (name or ID) - -.. option:: --project-domain - - Domain the project belongs to (name of ID). - This can be used in case collisions between project names exist. - -.. option:: --ingress - - Rule is applied to incoming traffic (default) - -.. option:: --egress - - Rule is applied to outgoing traffic - -.. option:: --exclude - - Exclude remote_ip_prefix from count of the traffic of IP addresses - -.. option:: --include - - Include remote_ip_prefix into count of the traffic of IP addresses - (default) - -.. option:: --remote-ip-prefix - - The remote IP prefix to associate with this metering rule packet - -.. _network_meter_rule_create: -.. describe:: - - Meter to associate with this meter rule (name or ID) - - -network meter rule delete -------------------------- - -Delete meter rule(s) - -.. program:: network meter rule delete -.. code:: bash - - openstack network meter rule delete [ ...] - -.. _network_meter_rule_delete: -.. describe:: - - ID of meter rule(s) to delete - -network meter rule list ------------------------ - -List meter rules - -.. program:: network meter rule list -.. code:: bash - - openstack network meter rule list - -network meter rule show ------------------------ - -Show meter rule - -.. program:: network meter rule show -.. code:: bash - - openstack network meter rule show - -.. _network_meter_show: -.. describe:: - - Meter rule to display (ID only) +.. autoprogram-cliff:: openstack.network.v2 + :command: network meter rule * -- cgit v1.2.1