diff options
| author | Akihiro Motoki <amotoki@gmail.com> | 2017-07-03 03:30:23 +0000 |
|---|---|---|
| committer | Akihiro Motoki <amotoki@gmail.com> | 2017-07-10 11:26:25 +0000 |
| commit | f2a4d5253ccaeababd4163960b8548f794ade708 (patch) | |
| tree | ab56f48fae8d4ade7d01b47b97a1249295d6d35a /doc | |
| parent | 423890a4950a725d6b493304d7b933d5b7c090d7 (diff) | |
| download | python-neutronclient-f2a4d5253ccaeababd4163960b8548f794ade708.tar.gz | |
doc: autogenerate neutron CLI reference
This replaces the doc-migration work. We can avoid the maintenance
cost by generating CLI reference for neutron CLI like this.
This patch introduces a new sphinx directive to render CLI
global options to achieve the goal. This can be migrated to
cliff sphinxext later.
Change-Id: I7089df3f7fc6475ebdd1e71221492baf12f18226
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/cli/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/cli/neutron-reference.rst | 48 |
2 files changed, 49 insertions, 0 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 8ba5923..f53a83a 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -60,3 +60,4 @@ neutron CLI :maxdepth: 2 neutron CLI guide <neutron> + neutron CLI reference <neutron-reference> diff --git a/doc/source/cli/neutron-reference.rst b/doc/source/cli/neutron-reference.rst new file mode 100644 index 0000000..24359a5 --- /dev/null +++ b/doc/source/cli/neutron-reference.rst @@ -0,0 +1,48 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + +===================== +neutron CLI reference +===================== + +.. warning:: + + neutron CLI is now deprecated and will be removed in the future. + Use openstack CLI instead. See `openstack CLI command list + <https://docs.openstack.org/python-openstackclient/latest/cli/command-list.html>`__ + and :doc:`its extensions for advanced networking services <osc_plugins>`. + The command mapping from neutron CLI to openstack CLI is available + `here <https://docs.openstack.org/python-openstackclient/latest/cli/decoder.html#neutron-cli>`__. + +neutron usage +------------- + +.. cliff-app:: neutronclient.shell.NeutronShell + :application: neutron + :arguments: 2.0 + +neutron API v2.0 commands +------------------------- + +.. autoprogram-cliff:: neutron.cli.v2 + :application: neutron + |