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