This has been deprecated for ages and generates an annoying warning when
building OSC docs. Time to cull it.
Change-Id: I76e4c7ab742d0bf27fecfda8fab41035618a4e24
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
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
With tox4 allowlist_externals is more strictly checked, so
fix it where necessary and fix pylint version.
Depends-On: https://review.opendev.org/c/zuul/zuul-jobs/+/866943
Related-Bug: #1999558
Change-Id: Id115a436b95b3ede5a1f3102b4bb9e3ade75c970
[1] was the last missing bit in OSC to have feature parity between
OpenStack client and Neutronclient CLI tools.
So now as [1] is merged we can really deprecate and specify that in Z
cycle we will remove neutronclient CLI.
This patch changes deprecation message to reflect that.
[1] https://review.opendev.org/c/openstack/python-openstackclient/+/768210
Change-Id: Ia68af29ea15bda7330fda1b18416798a0f4cb7a4
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Set openstackdocs_auto_name to use 'project' as name.
Depends-On: https://review.opendev.org/728938
Change-Id: I9e1dcc5c8861ac9d800ed7425b3e3193dd13c546
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Remove html_last_updated_fmt from conf.py, this is not needed with
openstackdocstheme anymore; update openstackdocstheme requirement
Change-Id: I66d7b502349de38bc2b646ed99cf5a41471d81bf
Bandit 1.6.0 introduces a regression[0] with the -x option,
a fix is expected to be included in 1.6.1 soon.
This commit also aligns Sphinx requirement with the requirements
project [2]. This is required to pass requirements-check.
The lower bound for sphinx was missing and requirements-check
now requires it, so the lower bound sphinx >=1.6.2 was added.
[0] https://github.com/PyCQA/bandit/issues/488
[1] https://github.com/PyCQA/bandit/pull/489
[2] https://review.opendev.org/#/c/657890/
Change-Id: I937cfa722f5234ca4d5506047001d9cb07728cd8
The current python binding examples have prompts of python
interactive mode, but these prompts make it difficult to
copy-and-paste the examples. This commit removes them.
Change-Id: Ia5d35fbb585ed0d0d11c8d035196981e9dd46785
This is the implementation of the "onboard network subnets" CLI.
This enables the subnet onboard feature of neutron to be driven via
CLI.
Depends-On: https://review.openstack.org/348080
Change-Id: Ic637ed689b0d3806d2c33faa419c3a98a310effa
Implements: blueprint subnet-onboard
Previously neutronclient has its own variant of cliff sphinx
extension to support cliff app autodocument (cliff-app directive).
The feature has been implemented in cliff 2.10.0.
This patch switches to the cliff official version.
The cliff official version also contains several nice fixes
around the sphinx extension.
Change-Id: If542fdf88ef57ec3ce8ecc017127b5dc194e6c9a
Networking-bgpvpn API extension [0] brings new API calls. That patch
adds command to OSC CLI to support them. It does not implement all the
API extension, still missing new router attribute 'advertise_extra_routes' and
the BGP VPN 'local_pref' attribute.
[0] https://developer.openstack.org/api-ref/network/v2/index.html#port-associations
Change-Id: I45a160b0caec534d517b103db91dc738c006978b
Partially-Implements: blueprint routes-control
Depends-On: I263e1ee6cf4e1a91be91a4a78f4a160f64d33cc6
Neutron is transitioning its CLI to OSC, should update dynamic routing
CLIs to align with OSC plugin.
Change-Id: Ic1a633ca103d9e97e28ddf23e0f528e0261ce497
Co-Authored-By: Ryan Tidwell <ryan@6tidwells.com>
Co-Authored-By: Roey Chen <roeyc@vmware.com>
Partially-Implements: blueprint bgp-spinout
Partial-Bug: #1560003
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
Recently cliff introduced a sphinx extension directive named autoprogram-cliff
which genarates command-line help automatically. By using it, we no longer
need to write command-line help document separately.
Also fixes minor string substitution issue in a BGPVPN command.
Note that the new cliff release with the directive is not released yet,
but there are several number of OSC plugin commands proposed and
having a local copy would help such developers.
Change-Id: I6b1aee89f406ac449fbc43e210c4ca7ad901b19b
* Move OSC first as neutron CLI is deprecated
* Add more information on OSC usage (links to embeded command list
and the mapping guide)
* Add deprecation notice for neutron CLI
This commit also makes toctree structure simpler
At now, we have two index page unlinked from the top page.
I thought it is good first, but it potentially makes things tricky.
Let's remove such tweaks for easy maintenance.
Change-Id: I7fd79f465fa6c04bf5b13f6578796d4c2d01edfd
The new simple configuration way was introduced in
openstackdocstheme 1.11.0. This commit introduces the new way.
Also drops unnecessary sphinx configurations like latex,
texinfo and manpages.
Change-Id: I587eb8cbd3e64c65dfc7247a01eca90af6adad4e
Neutron CLI itself is now deprecated. It means a kind of
feature freeze and we don't accept any changes on
adding/changing/dropping the existing commands.
The only exception is bug fixes on the deprecated neutron CLI.
It is better to document our policy on neutron CLI chnages.
Change-Id: I5f063c7eddbc9a91f587d5d3610092d07150f726
Stephen Finucane