Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / e377eae4a49f952edbedb234e9480ac463888f01 / . / index.rst
blob: 056bb95e10d4f6fe7662d2c6d43646298e50f686 [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
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame^]11 :glob:
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]12
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame^]13 overview/*
14
15.. toctree::
16 :maxdepth: 2
17 :caption: BBSim
18
19 bbsim/docs/source/index.rst
20
21.. toctree::
22 :maxdepth: 1
23 :caption: Release Notes
24 :glob:
25
26 release_notes/*
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]27
28.. toctree::
29 :maxdepth: 1
30 :caption: VOLTHA Core (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]31
32 voltha-go/README.md
33 voltha-go/quickstart.md
34 voltha-go/BUILD.md
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]35
36.. toctree::
37 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]38 :caption: Adapters (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]39
40 voltha-openolt-adapter/README.md
41
42.. toctree::
43 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]44 :caption: VOLTHA-protos (outdated)
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]45
46 voltha-protos/README.md
47
48.. toctree::
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]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`