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