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    release-notes/index
  24    getting-started-guide/index
  25    user-guide/index
  26    opendaylight-with-openstack/index
  27
  28
  29 Content for OpenDaylight Developers
  30 -----------------------------------
  31
  32 The following content is intended for developers building applications or code
  33 on top of OpenDaylight, but who do not plan to modify OpenDaylight code
  34 itself.
  35
  36 .. toctree::
  37    :maxdepth: 1
  38
  39    developer-guide/index
  40    javadoc
  41
  42 Content for OpenDaylight Contributors
  43 -------------------------------------
  44
  45 The following content is intended for developers who either currently
  46 participate in the development of OpenDaylight or would like to start.
  47
  48 * :doc:`Gerrit Guide <lfdocs:gerrit>`
  49 * :ref:`Infrastructure Guide <odl-infra>`
  50 * :doc:`Integration Testing Guide <odl-integration-test:index>`
  51 * :doc:`Integration Packaging Guide <odl-integration-packaging:index>`
  52
  53 .. toctree::
  54    :maxdepth: 1
  55
  56    documentation
  57    release-process/index
  58
  59
  60
  61 .. Commenting the below out until we actually use it
  62 .. Indices and tables
  63 .. ==================
  64 ..
  65 .. * :ref:`genindex`
  66 .. * :ref:`modindex`
  67 .. * :ref:`search`