..
  Copyright (C) 2011 OpenStack LLC.
 
  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 Burrow's documentation!
**********************************

Burrow is a message queue that can be used in a variety of
environments, from simple in-process queues to multi-tenant
cloud services. The design is extremely modular and can be
configured or extended to accommodate many use cases. For the
impatient who want to get something up and running quickly, see
:doc:`getting_started`. For a general introduction to message queues,
see the :doc:`introduction`. For an overview of how Burrow works,
see the :doc:`overview`. More detailed information and source code
documentation can be found below.

This documentation is generated by the Sphinx toolkit and lives in the
`Burrow source`_ tree. Additional documentation on Burrow and other
components of OpenStack can be found on the `OpenStack wiki`_.

.. _`Burrow source`: https://launchpad.net/burrow
.. _`OpenStack wiki`: http://wiki.openstack.org

Basics
======

.. toctree::
    :maxdepth: 1

    introduction
    overview
    getting_started

Details
=======

.. toctree::
    :maxdepth: 1

    protocols

Source Code
===========

.. toctree::
    :maxdepth: 2

    client
    server
    frontends
    backends
    common

* :ref:`modindex`
