Skip to content


Subversion checkout URL

You can clone with
Download ZIP
JavaScript XSLT CSS
Branch: master

Merge "Indicates frozen nature in README"

latest commit 5d5670b09e
Jenkins authored openstack-gerrit committed
Failed to load latest commit information.
tools Workflow documentation is now in infra-manual
v1.0 Merge "Fix various typos"
v2.0 Word "not" missing from Networking API v2.0
.gitignore doc-tools: Ignore build-*.log.gz
.gitreview Add .gitreview config file for gerrit.
README.rst Indicates frozen nature in README
doc-test.conf Rebuild 1.0 so that JSON fixes are picked up
test-requirements.txt Setup for openstack-doc-tools
tox.ini Add new checklinks tox environment


Netconn API

This repository is now frozen-in-time and will not accept new patches. To update Networking API information, please submit patches to for a new API feature and to for implemented API information.

It was the original holder for API information for the OpenStack Networking
project, also known as Neutron. The Neutron project provides open

source network connectivity to OpenStack Compute, the project named Nova.


Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.


Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3


To build:

cd v2.0
mvn clean generate-sources

The generated PDF documentation file is:


The root of the generated HTML documentation is:


Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

  • tox -e checkniceness - to run the niceness tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.


Refer to to see where these documents are published and to learn more about the OpenStack project.

Something went wrong with that request. Please try again.