docs/index.rst

   1 .. OpenDaylight Documentation documentation master file, created by
   2    sphinx-quickstart on Mon Mar 28 14:20:08 2016.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Welcome to OpenDaylight Documentation
   7 =====================================
   8
   9 The OpenDaylight documentation site acts as a central clearinghouse for
  10 OpenDaylight project and release documentation. If you would like to contribute
  11 to documentation, refer to the :ref:`documentation-guide`.
  12
  13 Getting Started with OpenDaylight
  14 ------------------------------
  15
  16 .. toctree::
  17    :maxdepth: 1
  18
  19    downloads
  20    release-notes/index
  21    getting-started-guide/index
  22
  23 OpenDaylight User Guides
  24 -------------------------
  25
  26 .. toctree::
  27    :maxdepth: 1
  28
  29    user-guide/index
  30
  31 OpenDaylight Developer Guides
  32 ------------------------------
  33
  34 .. toctree::
  35    :maxdepth: 1
  36
  37    developer-guide/index
  38    javadoc
  39
  40
  41 OpenDaylight Project Documentation
  42 -----------------------------------
  43
  44 Managed Projects
  45 ~~~~~~~~~~~~~~~~~
  46
  47 * :doc:`AAA Documentation <aaa:index>`
  48 * :doc:`BGPCEP Documentation <bgpcep:index>`
  49 * :doc:`Controller Documentation <controller:index>`
  50 * :doc:`COE Documentation <coe:index>`
  51 * :doc:`DAEXIM Documentation <daexim:index>`
  52 * :doc:`Genius Documentation <genius:index>`
  53 * :doc:`Infrautils Documentation <infrautils:index>`
  54 * :doc:`LISP Flow Mapping Documentation <lispflowmapping:index>`
  55 * :doc:`MD-SAL Documentation <mdsal:index>`
  56 * :doc:`NETCONF Documentation <netconf:index>`
  57 * :doc:`NetVirt Documentation <netvirt:index>`
  58 * :doc:`Neutron Documentation <neutron:index>`
  59 * :doc:`OpenFlowPlugin Documentation <openflowplugin:index>`
  60 * :doc:`OVSDB Documentation <ovsdb:index>`
  61
  62
  63 Self-Managed Projects
  64 ~~~~~~~~~~~~~~~~~~~~~~
  65
  66
  67 OpenDaylight Contributor Guides
  68 --------------------------------
  69
  70 * :doc:`Gerrit Guide <lfdocs:gerrit>`
  71 * :ref:`Infrastructure Guide <odl-infra>`
  72 * :doc:`Integration Testing Guide <odl-integration-test:index>`
  73 * :doc:`Integration Distribution Guide <odl-integration-distribution:index>`
  74 * :doc:`Integration Packaging Guide <odl-integration-packaging:index>`
  75
  76 .. toctree::
  77    :maxdepth: 1
  78
  79    documentation
  80    release-process/index
  81
  82
  83
  84 .. Commenting the below out until we actually use it
  85 .. Indices and tables
  86 .. ==================
  87 ..
  88 .. * :ref:`genindex`
  89 .. * :ref:`modindex`
  90 .. * :ref:`search`