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
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that the api-ref lives at
https://docs.openstack.org/api-ref/network/ and not /networking (that
was changed years ago). This change fixes this as well.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: I492ee1fe97ef0cdae0db0524d5b4df373ba07d41
This follows the nova docs and adds an in-tree neutron-specific
docs search and an openstack-wide search.
The former is necessary for finding things that aren't obviously
linked from top level indexes, like documentation about the
metadata service proxy (which is what I was originally trying
to find without the help of a search box).
Change-Id: I86dde1936d0c7d445f8a6db182f5f41dfb179752
The old link redirects to the top level of developer.o.o, replace
it with a link to the network api-ref instead.
Change-Id: Ifaed300c60e9afcf0f047b4370aa503d36c68836
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
The following commands are provided by the neutron repo,
so the corresponding CLI references are imported here.
- neutron-sanity-check
- neutron-debug
The purpose of this commit is just to import the CLI reference
related to the neutron repo as-is.
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Ib514b3653cff615ee5b14e087fdd5985d7c4285b
openstackdocstheme generates the toc tree in the left sidebar
based on the page hierarchy from the top page.
The previous developer guide hirarchy is a bit deep, and
this commit reorganizes the devref pages for better navigation
with openstackdocstheme.
Change-Id: I1412b047efc1c268b34ef97e78073da7bcbb6d7e
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
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
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
* Display more contents in the top page.
It is useful to access various things from the top page.
The contents after this change looks reasonable.
* Remove "Indices and tables" section in policies and stadium index.
They are unnecessary.
Change-Id: I49a966ce96af107c6f17f4caa73f9a634db37e18
This commits moves the Neutron Stadium documentation to the toplevel
portion of the documentation tree.
Change-Id: I0ec585975c453a9dd08d22293bb68dbc775802e6
Signed-off-by: Kyle Mestery <mestery@mestery.com>
The link to Dashboard is broken in the generated docuemnt
http://docs.openstack.org/developer/neutron/
This patch fixes it and addresses warnings so that
tox -e docs works.
Also add a reference to Gerrit Dashboard Creator
so that developers can customize it to what they want.
Change-Id: Ic45ab48e68af9e5e8255161fe9eb2354ae124f50
Move the dashboard directory under the source tree so that
it is available on generated builds. In addition, recast
image pages as RST so that they will be rendered
Change-Id: I316128491e8dae70ac06e260f5bdd8f440d285aa
Signed-off-by: Ryan Moats <rmoats@us.ibm.com>
The information from the NeutronPolicies wiki page [1] is useful. But
having it in a static wiki is less so. Moving this into the Neutron
documentation in-tree will allow for an easier maintenance of this
information.
[1] https://wiki.openstack.org/wiki/NeutronPolicies
Change-Id: I23cada04031e00f48c0f6dc26a992ed204195526
There is currently no useful developer-focused documentation in-tree
for Neutron. There are a smattering of useful documents on the
OpenStack wiki, however, there isn't a good organization to this
information, nor is there a condensed developer focus to a lot of it.
Some of the wiki pages are more proposals for features or bug fixes,
and there is a need for architecture, design, and code walk-through
documentation for Neutron to help with new (and existing) contribution.
This patch begins the process of adding developer documentation to Neutron.
It updates the main developer reference index.rst to pull in-line with what
Nova is doing, leaving some todo references for future patches. It also
adds a development.environment tutorial that is up-to-date with current
Neutron development, using tox/testr processes for running unit tests and
including a number of references to external wiki pages that have
instructions for using DevStack for OpenStack contribution/testing.
The next series of patches will add automodule documentation to the
developer reference for some of the major modules in Neutron.
Change-Id: I23aaa11d9a174f24242c49767b92540f5e25b48a
Addresses: blueprint quantum-developer-docs
This change renames everything to Neutron while providing backwards
compatible adjustments for Grizzly configuration files.
implements blueprint: remove-use-of-quantum
Change-Id: Ie7d07ba7c89857e13d4ddc8f0e9b68de020a3d19
The quantum.quantum_plugin_base_v2 module had some good docstrings,
but there was no corresponding sphinx code that would generate
docs from them. There were also some syntax issues with the
sphinx markup in the docstrings.
This change adds sphinx directives so these docs will be auto-
generated. It also modifies the docstrings in the QuantumPluginBaseV2
methods so they are parsed by the Sphinx documentation generator
without any errors.
If this patch is accepted, a "Plugin API" link to these docs
will appear at
http://docs.openstack.org/developer/quantum/
Fixes bug 1186255
Change-Id: I96eddcc516d109766d7f4c52edd595748696b595
Implements the blueprint use-common-cfg
In order for the linuxbridge plugin to use the rpc code soon to be merged into
openstack-common, we need to parse our configuration using cfg. Here we
make the most simple, backwards compatible change in that direction.
The same is relevant for the openvswitch implementation
Fixes after comments.
Change-Id: I70fc1898a802cb4198f72741453283d114added2
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
Slawek Kaplonski