Virtual private network services for OpenStack Neutron.
Go to file
Lorin Hochstein 28884ffaa4 Sphinx-ify QuantumPluginBaseV2 docstrings
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
2013-05-31 09:47:49 -04:00
bin blueprint mellanox-quantum-plugin 2013-05-13 15:36:14 +03:00
contrib Update tox.ini to support RHEL 6.x. 2013-03-08 08:52:25 -05:00
doc Sphinx-ify QuantumPluginBaseV2 docstrings 2013-05-31 09:47:49 -04:00
etc Fix quantum.conf comment 2013-05-23 08:20:18 +00:00
quantum Sphinx-ify QuantumPluginBaseV2 docstrings 2013-05-31 09:47:49 -04:00
tools Perform a sync with oslo-incubator. 2013-05-23 15:58:33 -07:00
.bzrignore bp/api-filters 2012-01-25 08:51:51 +00:00
.coveragerc Update .coveragerc 2013-02-06 16:47:06 +02:00
.gitignore Move to pbr. 2013-05-17 08:31:44 -07:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:06:42 -04:00
.mailmap update mailmap 2013-05-23 08:47:08 +00:00
.pylintrc Bug #890028 2011-12-14 00:33:37 +00:00
.testr.conf Allow pdb debugging in manually-invoked tests. 2013-04-09 02:46:40 +00:00
babel.cfg Use babel to generate translation file 2013-01-24 00:20:32 +08:00
HACKING.rst Remove locals() from strings substitutions 2013-04-20 11:56:26 +00:00
LICENSE Adding Apache Version 2.0 license file. This is the official license agreement under which Quantum code is available to 2011-08-08 12:31:04 -07:00
MANIFEST.in Updated to latest oslo-version code. 2013-02-04 11:21:16 +11:00
openstack-common.conf Move to pbr. 2013-05-17 08:31:44 -07:00
README Document that code is on github now in README. 2013-01-18 16:27:46 +13:00
run_tests.py Enable automatic validation of many HACKING rules. 2013-04-11 19:48:28 +00:00
run_tests.sh Revert "Fix ./run_tests.sh --pep8" 2013-05-22 13:51:07 +09:00
setup.cfg Move to pbr. 2013-05-17 08:31:44 -07:00
setup.py Move to pbr. 2013-05-17 08:31:44 -07:00
TESTING Update TESTING file 2012-08-23 01:22:47 -07:00
tox.ini Revert "Fix ./run_tests.sh --pep8" 2013-05-22 13:51:07 +09:00

# -- Welcome!

  You have come across a cloud computing network fabric controller.  It has
  identified itself as "Quantum."  It aims to tame your (cloud) networking!

# -- External Resources:

 The homepage for Quantum is: http://launchpad.net/quantum .  Use this
 site for asking for help, and filing bugs. Code is available on github at
 <http://github.com/openstack/quantum>.

 The latest and most in-depth documentation on how to use Quantum is
 available at: <http://docs.openstack.org>.  This includes:

 Quantum Administrator Guide
 http://docs.openstack.org/trunk/openstack-network/admin/content/

 Quantum API Reference:
 http://docs.openstack.org/api/openstack-network/2.0/content/

 The start of some developer documentation is available at:
 http://wiki.openstack.org/QuantumDevelopment

 For help using or hacking on Quantum, you can send mail to
 <mailto:openstack-dev@lists.openstack.org>.