f2a4d5253c
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
49 lines
1.6 KiB
ReStructuredText
49 lines
1.6 KiB
ReStructuredText
..
|
|
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
|
|
|