..
      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