The ovn.ini file is a hold-over from the networking-ovn
tree. The docs all reference configuring OVN (and OVS)
options in ml2_conf.ini, so remove the old file and add
the neutron.ml2.ovn namespace to
etc/oslo-config-generator/ml2_conf.ini.
Trivialfix
Change-Id: I26dedc80e07aedffb1713560d4431b7a334b70b5
Switch to openstackdocstheme 2.2.1 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.
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.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I780eea00c9c47f52dcc7928546fd22dec5d145b4
The code to generate a support matrix has been pulled into a common
library. Using this instead of duplicating code in various projects that
need it.
Change-Id: I72d722af659a35266a9a391f4a73035b2bd3dabd
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
Co-Authored-By: Slawek Kaplonski <skaplons@redhat.com>
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.
Follow this rename.
Change-Id: Id17cfdce6c38dc30bfaf557be7eee0675fa8f87c
The following changes are made for PDF document.
- Sample config/policy files are skipped for PDF doc build.
We hit several problems around verbatim of inline samples
in neutron, nova and others, so we decided to skip them now.
Downloadable links also should be avoided in PDF doc
as PDF doc is expected to work alone.
- tocdepth for latex is explicitly set to 3 for better navigation
in the generated PDF. The default was 1 and we cannot provide
enough information in PDF TOC.
- The module index is disabled as the neutron document does not
generate a full module index and it shows only partial entries.
'makeindex' and 'printindex' are set to empty in latex_elements.
The existing contents (mainly the top page) are reorganized a bit
for a better TOC of the generated PDF document:
- The top page of the documentation is simplified only with toctree
to avoid almost duplicated entries in the TOC of the PDF documentation.
The current TOC for PDF doc seems to use section titles as the first
level and title of linked pages as the second level. They are almost
same and the generated TOC would be redundant.
- The link to the API reference in the top page was moved
to a subdirectory so that PDF TOC can include it.
- 'Search' section is shown in index.rst only when the builder is 'html'
as this section uses a form and makes sense only for HTML doc.
Story: 2006099
Task: 35127
Depends-On: https://review.opendev.org/664555
Change-Id: I6f1614a643efa7fad3c2a6ce5692d6873ca0ebd0
It is not needed and create problems when trying to create the
documentation from an sdist tarball when git is installed (see [0] how
the problem will be solved in openstackdocstheme).
[0] https://review.opendev.org/#/c/677868/
Change-Id: Iff0c9a4e99ecc16e495fb6283479839595037bc0
This is the preparation of migration to DocumendedRuleDefault.
Partially Implements: blueprint neutron-policy-in-code
Change-Id: I1d10f5db43167a04546565545d7d21010d16a808
Incorrectly named variable in the doc conf file causing errors.
Now that jobs are running under python 3, error with dict_key
sort() no longer being supported.
Change-Id: If93b61a84e6106de7f530e4fa1084a473b413629
This patch updates our doc conf.py to support the linkcheck builder in
addition to adding a new 'linkcheck' target in tox to run the builder.
Also the release checklist is updated suggesting the linkcheck tox
target be run prior to a release.
Change-Id: Ia7c282b7331f0b624bb3324f27dfec223cf414f7
Closes-Bug: #1716005
This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.
Change-Id: I1cd098c1f5744695d3694791750e4770f8d39dca
oslo.config provides sphinx extensions to generate config reference
and sample config files. This commit enables the auto-generation of
the networking config reference.
Part of doc-migration work
Suppress pyroute2 warning to pass the doc build.
Change-Id: I74f0def7110674a6a735af77b9b07fb679b2959d
* Switch the release note theme to openstackdocstheme.
* Use the new style of setting of openstackdocstheme
of the in-tree documentation.
Change-Id: I0424f097c0f5d78a539bc997e2cd61119d606524
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I82de8ad2a254843434e960f8b093ac8bba2ba89b
The docs reorganization proposed in the docs-specs [1],
we will migrate our sphinx theme to openstackdocsthems.
This commit switches our docs theme to it,
Also ajust title levels. openstackdocstheme assume one title (first
level) per page. Second or later first-level titles are not shown.
This changes title levels to match openstackdocsthem requirements.
Note that oslosphinx is used by releasenotes build,
so it is not dropped from test-requirements.txt.
[1] https://review.openstack.org/#/c/472275/
Change-Id: I72d55c26401ae9bfd06626d1b1584a368bbd9f86
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Changing Popen to .check_output because of 3 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]
3. It makes the code look much better.
[1] https://review.openstack.org/#/c/457142/
[2] https://review.openstack.org/#/c/433081
Change-Id: Ifeff184b71a83b78de751dfd0c2f43a33cd409ee
The feature classification matrix will provide information about
plugins and the features they support.
Acts as a launching point for users to read about the intent
of the matrix before reviewing the matrix to find features and plugins
that meet their needs.
Will implement a page where users can view Neutron features
and plugins and their status.
Similar to Nova's implementation here:
http://docs.openstack.org/developer/nova/feature_classification.htmlhttp://docs.openstack.org/developer/nova/support-matrix.html
Co-Authored-By: Darek Smigiel <dariusz.smigiel@intel.com>
Closes-Bug: #1580327
Change-Id: I67f4dc67883623decdbf136c598eb9e2d0bc24c4
Basically, the commit removes the file encoding - since jenkins is fine
with it, means it was really unnecessary and the change makes sense.
Change-Id: Id0821c9b11b9efad1836596c407566c9eb4dc11a
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: I6e6c59b101760224008fd902c8c258d6120a615d
Closes-Bug: #1552251
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.
Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I2ff32c4dc37c543696125ac755dc4adb69ddacdf
Partial-Bug: #1529836
The configuration options come from oslo and the server
executable is usually wrapped in a service script, supplied
by packagers and/or deployment tools. Any extra documentation
available in tree is of relative value, and the fact that
this file has been virtually ignored ever since it was
added is a testament of that.
Let's stop its agony and wish it to rest in peace.
Closes-bug: #1520041
Change-Id: If5bba557526903b8064ee28628a21c3459ca85bc
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
This change renames everything to Neutron while providing backwards
compatible adjustments for Grizzly configuration files.
implements blueprint: remove-use-of-quantum
Change-Id: Ie7d07ba7c89857e13d4ddc8f0e9b68de020a3d19
Use commit eaab5fae2502198e9fa57d0d90a7204a2bd83b16:
Merge "sort options to make --help output prettier"
(Wed Feb 13 12:52:14 2013 +0000)
Add processutils to quantum since impl_zmq depends on them.
Drop notifier.list_notifier that is not present in oslo.
Change-Id: I91d9ec05481b8c24da9fbee1ad4706ff56a3b7aa
Fixes: bug #1116290
Updating setup and version require code changes in the code base. This is done
here to support Id9c116a1e10e5c240913fae7a127110b806eff0f
Change-Id: I60b6dd6d684982e33de8fbf051a3dcaf98cb9b87
* Fixes LP1007132
* Adds keystone link
* removes __init__.py since doc/source is not a python module
Change-Id: I6a3234fa760ca23889e352735669547ad9afedf8
bug 995283
Changes after initial comments
Removed spaces
Updates after comments
Remove white spaces
Fix text and remove empty files
Remove config.py
Updated to be similar to the keystone page
Updated afetr comments
Change-Id: If9240114ae31d7120c708cdcf883e8fe4c7d2bb2
merge salv's fix to remove keystone middleware: lp855151
one more 202->200 from tyler
merge tylers additional 202 -> 200 changes
merge additions to OVS readme describing running with multiple hosts
merge brad's changes to make create API calls return 200, not 202
merge unit test for showing unset attachment
merging API docs branch
Merge: lp:~yinliu2/quantum/bug856564
Merge: lp:~bgh/quantum/bug850261
Change-Id: I56fe24c59f918737e57b562343c33ec6dcceac60
Brian Haley