Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / 1f5530b010039cc47272895ff5bb61b9b16939a3 / . / index.rst
blob: bd1a3da87437acd0fbebbf58e5bc25e1e26af6f2 [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
13 overview/deploy-virtual.rst
14 overview/development_loop.rst
15 overview/troubleshooting.rst
16 overview/known_issues.rst
17 overview/contribute.rst
18
19.. toctree::
20 :maxdepth: 1
21 :caption: VOLTHA Core (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]22
23 voltha-go/README.md
24 voltha-go/quickstart.md
25 voltha-go/BUILD.md
26 voltha-go/python/adapters/BUILD_ENV.md
27 voltha-go/python/adapters/README.md
28 voltha-go/python/cli/docs/README.md
29
30.. toctree::
31 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame^]32 :caption: Adapters (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]33
34 voltha-openolt-adapter/README.md
35
36.. toctree::
37 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame^]38 :caption: VOLTHA-protos (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]39
40 voltha-protos/README.md
41
42.. toctree::
43 :maxdepth: 2
44 :caption: BBSim
45
46 bbsim/docs/source/index.rst
47
48.. toctree::
49 :maxdepth: 1
50 :caption: Documentation Notes
51
52 readme
53
54
55
56Indices and tables
57==================
58
59* :ref:`genindex`
60* :ref:`modindex`
61* :ref:`search`