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