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
57 lines
1.9 KiB
ReStructuredText
57 lines
1.9 KiB
ReStructuredText
..
|
|
Copyright 2011 OpenStack Foundation
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
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`_.
|
|
|
|
.. _`Quantum API Guide`: http://docs.openstack.org/incubation/openstack-network/developer/quantum-api-1.0/content/
|
|
|
|
This document describes Quantum for contributors of the project, and assumes
|
|
that you are already familiar with Quantum from an `end-user perspective`_.
|
|
|
|
.. _`end-user perspective`: http://docs.openstack.org/trunk/openstack-network/admin/content/index.html
|
|
|
|
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.
|
|
|
|
.. _`OpenStack wiki`: http://wiki.openstack.org
|
|
.. _`Quantum Development wiki`: http://wiki.openstack.org/QuantumDevelopment
|
|
|
|
Enjoy!
|
|
|
|
Development Documents
|
|
=====================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
devref/plugin-api
|
|
devref/index
|
|
devref/common
|
|
|
|
Man Pages
|
|
---------
|
|
|
|
.. toctree::
|
|
|
|
man/quantum-server
|