28884ffaa4
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
# -- 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>.