doc/source/devref/index.rst

   1 ..
   2       Copyright 2010-2011 United States Government as represented by the
   3       Administrator of the National Aeronautics and Space Administration.
   4       All Rights Reserved.
   5
   6       Licensed under the Apache License, Version 2.0 (the "License"); you may
   7       not use this file except in compliance with the License. You may obtain
   8       a copy of the License at
   9
  10           http://www.apache.org/licenses/LICENSE-2.0
  11
  12       Unless required by applicable law or agreed to in writing, software
  13       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  14       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  15       License for the specific language governing permissions and limitations
  16       under the License.
  17
  18       Convention for heading levels in Neutron devref:
  19       =======  Heading 0 (reserved for the title in a document)
  20       -------  Heading 1
  21       ~~~~~~~  Heading 2
  22       +++++++  Heading 3
  23       '''''''  Heading 4
  24       (Avoid deeper levels because they do not render well.)
  25
  26
  27 Developer Guide
  28 ===============
  29
  30 In the Developer Guide, you will find information on Neutron's lower level
  31 programming APIs. There are sections that cover the core pieces of Neutron,
  32 including its database, message queue, and scheduler components. There are
  33 also subsections that describe specific plugins inside Neutron. Finally,
  34 the developer guide includes information about Neutron testing infrastructure.
  35
  36
  37 Programming HowTos and Tutorials
  38 --------------------------------
  39 .. toctree::
  40     :maxdepth: 3
  41
  42     effective_neutron
  43     development.environment
  44     contribute
  45     neutron_api
  46     client_command_extensions
  47     alembic_migrations
  48
  49
  50 Neutron Internals
  51 -----------------
  52 .. toctree::
  53    :maxdepth: 3
  54
  55    services_and_agents
  56    api_layer
  57    ml2_ext_manager
  58    quota
  59    api_extensions
  60    plugin-api
  61    db_layer
  62    policy
  63    rpc_api
  64    rpc_callbacks
  65    layer3
  66    l2_agents
  67    ovs_vhostuser
  68    quality_of_service
  69    advanced_services
  70    oslo-incubator
  71    callbacks
  72    dns_order
  73    upgrade
  74    i18n
  75    instrumentation
  76    address_scopes
  77
  78 Testing
  79 -------
  80 .. toctree::
  81    :maxdepth: 3
  82
  83    fullstack_testing
  84    testing_coverage
  85    template_model_sync_test
  86
  87 Module Reference
  88 ----------------
  89 .. toctree::
  90    :maxdepth: 3
  91
  92 .. todo::
  93
  94     Add in all the big modules as automodule indexes.
  95
  96
  97 Indices and tables
  98 ------------------
  99
 100 * :ref:`genindex`
 101 * :ref:`modindex`
 102 * :ref:`search`