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 following guides and documentation provides details on various aspects of
  10 OpenDaylight from the user guides to the developer guides and tries to act as
  11 a single point of contact for all documentation related articles in OpenDaylight.
  12 If you would like to contribute to documentation please refer to the :ref:`documentation-guide`.
  13
  14 Content for OpenDaylight Users
  15 ------------------------------
  16
  17 The following content is intended for people who would like to deploy, use, or
  18 just learn more about OpenDaylight.
  19
  20 .. toctree::
  21    :maxdepth: 1
  22
  23    downloads
  24    release-notes/index
  25    getting-started-guide/index
  26    user-guide/index
  27    opendaylight-with-openstack/index
  28
  29
  30 Content for OpenDaylight Developers
  31 -----------------------------------
  32
  33 The following content is intended for developers building applications or code
  34 on top of OpenDaylight, but who do not plan to modify OpenDaylight code
  35 itself.
  36
  37 .. toctree::
  38    :maxdepth: 1
  39
  40    developer-guide/index
  41    javadoc
  42
  43 Content for OpenDaylight Contributors
  44 -------------------------------------
  45
  46 The following content is intended for developers who either currently
  47 participate in the development of OpenDaylight or would like to start.
  48
  49 * :doc:`Gerrit Guide <lfdocs:gerrit>`
  50 * :ref:`Infrastructure Guide <odl-infra>`
  51 * :doc:`Integration Testing Guide <odl-integration-test:index>`
  52 * :doc:`Integration Distribution Guide <odl-integration-distribution:index>`
  53 * :doc:`Integration Packaging Guide <odl-integration-packaging:index>`
  54
  55 .. toctree::
  56    :maxdepth: 1
  57
  58    documentation
  59    release-process/index
  60
  61
  62
  63 .. Commenting the below out until we actually use it
  64 .. Indices and tables
  65 .. ==================
  66 ..
  67 .. * :ref:`genindex`
  68 .. * :ref:`modindex`
  69 .. * :ref:`search`