3a9306054b
There is currently no useful developer-focused documentation in-tree for Neutron. There are a smattering of useful documents on the OpenStack wiki, however, there isn't a good organization to this information, nor is there a condensed developer focus to a lot of it. Some of the wiki pages are more proposals for features or bug fixes, and there is a need for architecture, design, and code walk-through documentation for Neutron to help with new (and existing) contribution. This patch begins the process of adding developer documentation to Neutron. It updates the main developer reference index.rst to pull in-line with what Nova is doing, leaving some todo references for future patches. It also adds a development.environment tutorial that is up-to-date with current Neutron development, using tox/testr processes for running unit tests and including a number of references to external wiki pages that have instructions for using DevStack for OpenStack contribution/testing. The next series of patches will add automodule documentation to the developer reference for some of the major modules in Neutron. Change-Id: I23aaa11d9a174f24242c49767b92540f5e25b48a Addresses: blueprint quantum-developer-docs
1.4 KiB
1.4 KiB
Developer Guide
In the Developer Guide, you will find information on Neutron's lower level programming APIs. There are sections that cover the core pieces of Neutron, including its database, message queue, and scheduler components. There are also subsections that describe specific plugins inside Neutron.
Programming HowTos and Tutorials
development.environment
Module Reference
Add in all the big modules as automodule indexes.
Indices and tables
genindexmodindexsearch