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 the OpenDaylight Handbook!
   7 =====================================
   8
   9 This handbook provides details on various aspects of OpenDaylight from the user
  10 guides to the developer guides and tries to act as a single point of contact
  11 for all documentation related articles in OpenDaylight. If you would like to
  12 contribute to the Handbook 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
  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
  53 .. toctree::
  54    :maxdepth: 1
  55
  56    submodules/releng/builder/docs/index
  57    documentation
  58    release-process/index
  59    submodules/genius/docs/index
  60    submodules/infrautils/docs/index
  61    submodules/netvirt/docs/index
  62    submodules/openflowplugin/docs/index
  63    submodules/sfc/docs/index
  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`