python-neutronclient/doc/source/index.rst
Slawek Kaplonski 52653c95e0 Remove the CLI code from the Neutron client.
This project no longer provides CLI support. All code has been
removed. Please use openstack CLI instead

This patch removes entry point for neutron CLI too, bash completion
script and CLI related functional and unit tests but it
still keeps neutronclient/neutron/v2_0 module as this is used by e.g.
Nova.

Co-Authored-By: Slawek Kaplonski <skaplons@redhat.com>

Closes-Bug: #2003861
Change-Id: I5b6c735d1ff931d7991a42b262e7faa47b75edeb
2023-04-11 13:12:45 +02:00

66 lines
1.9 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.)
==================================
python-neutronclient documentation
==================================
This is a client for OpenStack Networking API. It provides
:doc:`Python API bindings <reference/index>` (the neutronclient module).
There is
`OpenStack Client (OSC) <https://docs.openstack.org/python-openstackclient/latest/>`__.
CLI which support the Networking API.
User Documentation
------------------
.. toctree::
:maxdepth: 2
cli/index
reference/index
Contributor Guide
-----------------
In the :doc:`Contributor Guide <contributor/index>`, you will find
information on neutronclient's lower level programming details or APIs
as well as the transition to OpenStack client.
.. toctree::
:maxdepth: 2
contributor/index
.. note::
neutron CLI has been deprecated from Ocata release.
We do not add, change and drop any existing commands any more.
We only accept changes on OSC plugin, neutronclient python bindings
and bug fixes on the deprecated CLI (``neutron`` command).
History
-------
Release notes is available at
http://docs.openstack.org/releasenotes/python-neutronclient/.