Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / 88df47431094ae61fadac16c7f21b2235941507f / . / index.rst
blob: dc0c21e70a7b15dab8f14d526a0c262d5bfedb87 [file] [log] [blame]
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]1VOLTHA Documentation
2====================
3
4.. image:: images/VOLTHA_LOGO.png
5
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]6Welcome to the VOLTHA project documentation.
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]7
8.. toctree::
9 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]10 :caption: Overview
11
12 overview/deploy-physical.rst
Zack Williamsc6460c22019-12-18 14:54:43 -0700[diff] [blame]13 overview/physical_layout.rst
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]14 overview/deploy-virtual.rst
15 overview/development_loop.rst
16 overview/troubleshooting.rst
17 overview/known_issues.rst
18 overview/contribute.rst
19
20.. toctree::
21 :maxdepth: 1
22 :caption: VOLTHA Core (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]23
24 voltha-go/README.md
25 voltha-go/quickstart.md
26 voltha-go/BUILD.md
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]27
28.. toctree::
29 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]30 :caption: Adapters (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]31
32 voltha-openolt-adapter/README.md
33
34.. toctree::
35 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]36 :caption: VOLTHA-protos (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]37
38 voltha-protos/README.md
39
40.. toctree::
41 :maxdepth: 2
42 :caption: BBSim
43
44 bbsim/docs/source/index.rst
45
46.. toctree::
47 :maxdepth: 1
48 :caption: Documentation Notes
49
50 readme
51
52
53
54Indices and tables
55==================
56
57* :ref:`genindex`
58* :ref:`modindex`
59* :ref:`search`