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    developer-guide/developing-apps-on-the-opendaylight-controller
  23
  24 OpenDaylight Project Documentation
  25 ----------------------------------
  26
  27 Managed Projects
  28 ~~~~~~~~~~~~~~~~
  29
  30 * :doc:`AAA Documentation <aaa:index>`
  31 * :doc:`BGPCEP Documentation <bgpcep:index>`
  32 * :doc:`COE Documentation <coe:index>`
  33 * :doc:`Controller Documentation <controller:index>`
  34 * :doc:`DAEXIM Documentation <daexim:index>`
  35 * :doc:`Genius Documentation <genius:index>`
  36 * :doc:`Infrautils Documentation <infrautils:index>`
  37 * :doc:`JSON RPC Documentation <jsonrpc:index>`
  38 * :doc:`LISP Flow Mapping Documentation <lispflowmapping:index>`
  39 * :doc:`MD-SAL Documentation <mdsal:index>`
  40 * :doc:`NetConf Documentation <netconf:index>`
  41 * :doc:`NetVirt Documentation <netvirt:index>`
  42 * :doc:`OpenFlowPlugin Documentation <openflowplugin:index>`
  43 * :doc:`OVSDB Documentation <ovsdb:index>`
  44
  45 .. :doc:`Neutron Documentation <neutron:index>`
  46
  47
  48 Self-Managed Projects
  49 ~~~~~~~~~~~~~~~~~~~~~
  50
  51 * :doc:`TransportPCE Documentation <transportpce:index>`
  52
  53 OpenDaylight Contributor Guides
  54 -------------------------------
  55
  56 * :doc:`Gerrit Guide <lfdocs:gerrit>`
  57 * :ref:`Infrastructure Guide <odl-infra>`
  58 * :doc:`Integration Testing Guide <odl-integration-test:index>`
  59 * :doc:`Integration Distribution Guide <integration-distribution:index>`
  60 * :doc:`Integration Packaging Guide <odl-integration-packaging:index>`
  61 * :doc:`Release Process Guide <release-process/index>`
  62 * :doc:`Documentation Guide <documentation>`
  63 * :doc:`Javadocs <javadoc>`
  64
  65
  66 .. Commenting the below out until we actually use it
  67 .. Indices and tables
  68 .. ==================
  69 ..
  70 .. * :ref:`genindex`
  71 .. * :ref:`modindex`
  72 .. * :ref:`search`
  73
  74
  75 .. toctree::
  76    :maxdepth: 1
  77    :hidden:
  78
  79    documentation
  80    release-process/index
  81    javadoc
  82    user-guide/index
  83    developer-guide/index