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
1.9 KiB
1.9 KiB
Welcome to Quantum's developer documentation!
Quantum is an OpenStack project to provide "network connectivity as a service" between interface devices (e.g., vNICs) managed by other Openstack services (e.g., nova). It implements the Quantum API Guide.
This document describes Quantum for contributors of the project, and assumes that you are already familiar with Quantum from an end-user perspective.
This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Quantum and other components of OpenStack can be found on the OpenStack wiki. The Quantum Development wiki is a very good place to start.
Enjoy!
Development Documents
devref/plugin-api devref/index devref/common
Man Pages
man/quantum-server