]> review.fuel-infra Code Review - openstack-build/neutron-build.git/commit
Sphinx-ify QuantumPluginBaseV2 docstrings
authorLorin Hochstein <lorin@nimbisservices.com>
Sun, 26 May 2013 20:42:21 +0000 (16:42 -0400)
committerLorin Hochstein <lorin@nimbisservices.com>
Fri, 31 May 2013 13:47:49 +0000 (09:47 -0400)
commit28884ffaa49cb6ff7f0c18a646c55b0387d6282f
treebde3b76c8b3267c486ce92a6b42ed66c5f22cc82
parentb8960ea39378a2fa5ea96e2a25a20cb794f5dde6
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
doc/source/devref/plugin-api.rst [new file with mode: 0644]
doc/source/index.rst
quantum/quantum_plugin_base_v2.py