f9b06e8937
Also fixes sphinx warnings in existing docstrings. Change-Id: Iccccd782ff8b80a3fd2764e7ef9cc3dde46e32ee
53 lines
2.0 KiB
ReStructuredText
53 lines
2.0 KiB
ReStructuredText
..
|
|
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 Neutron Lib documentation!
|
|
=====================================
|
|
|
|
Neutron-lib is an OpenStack library project used by Neutron, Advanced Services,
|
|
and third-party projects that aims to provide common functionality across all
|
|
such consumers. The library is developed with the following goals in mind:
|
|
|
|
- Decouple sub-projects from Neutron (i.e. no direct neutron imports in
|
|
sub-projects).
|
|
- Pay down Neutron technical debt via refactoring/re-architecting of
|
|
sub-optimal patterns in their respective neutron-lib implementation.
|
|
|
|
This document describes the library for contributors of the project, and assumes
|
|
that you are already familiar with Neutron 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 Neutron and other components of OpenStack
|
|
can be found on the `OpenStack wiki`_ and the `Neutron section of the wiki`.
|
|
The `Neutron Development wiki`_ is also a good resource for new contributors.
|
|
|
|
.. _`OpenStack wiki`: http://wiki.openstack.org
|
|
.. _`Neutron section of the wiki`: http://wiki.openstack.org/Neutron
|
|
.. _`Neutron Development wiki`: http://wiki.openstack.org/NeutronDevelopment
|
|
|
|
Enjoy!
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
install/index
|
|
user/index
|
|
contributor/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
reference/index
|