Updated git submodules
[docs.git] / 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    user-guide/index
25    opendaylight-with-openstack/index
26
27
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 .. toctree::
36    :maxdepth: 1
37
38    developer-guide/index
39
40
41 Content for OpenDaylight Contributors
42 -------------------------------------
43
44 The following content is intended for developers who either currently
45 participate in the development of OpenDaylight or would like to start.
46
47 .. toctree::
48    :maxdepth: 1
49
50    gerrit
51    submodules/releng/builder/docs/index
52    submodules/integration/test/docs/index
53    documentation
54    release-process/index
55    submodules/spectrometer/docs/index
56    javadoc
57    submodules/genius/docs/index
58    submodules/infrautils/docs/index
59    submodules/netvirt/docs/contributor-guide/index
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`