64211231be
Setup the docs target for producing documentation, create the needed index files for documentation and devref, and include references to the existing .rst docs. Change-Id: Id2a23058ee5aa557fb52b65f044bac4528ef86bc Implements: blueprint neutron-lib
56 lines
1.8 KiB
ReStructuredText
56 lines
1.8 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 developer documentation!
|
|
===============================================
|
|
|
|
Neutron-lib is an OpenStack library project used by Neutron, Advanced Services,
|
|
and third-party projects to provide common functionality and remove duplication.
|
|
|
|
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!
|
|
|
|
|
|
Programming HowTos and Tutorials
|
|
--------------------------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
readme
|
|
installation
|
|
usage
|
|
review-guidelines
|
|
contributing
|
|
|
|
|
|
Developer Docs
|
|
==============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
devref/index
|