blob: b22db7e1f699589df5fffe238617ead3c5135c77 [file] [log] [blame]
Zack Williams071eda22019-05-15 18:19:51 -07001VOLTHA Documentation
2====================
3
4.. image:: images/VOLTHA_LOGO.png
5
Matteo Scandolo1f5530b2019-12-17 10:12:31 -08006Welcome to the VOLTHA project documentation.
Zack Williams071eda22019-05-15 18:19:51 -07007
8.. toctree::
9 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080010 :caption: Overview
Zack Williamse377eae2019-12-20 16:40:38 -070011 :glob:
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080012
Zack Williamse377eae2019-12-20 16:40:38 -070013 overview/*
14
15.. toctree::
Andrea Campanella4cf8ba02020-01-21 18:01:59 +010016 :maxdepth: 1
17 :caption: Voltctl
18 :glob:
19
20 voltctl
21
22.. toctree::
Zack Williamse377eae2019-12-20 16:40:38 -070023 :maxdepth: 2
24 :caption: BBSim
25
26 bbsim/docs/source/index.rst
27
28.. toctree::
29 :maxdepth: 1
30 :caption: Release Notes
31 :glob:
32
33 release_notes/*
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080034
35.. toctree::
36 :maxdepth: 1
37 :caption: VOLTHA Core (outdated)
Zack Williams071eda22019-05-15 18:19:51 -070038
39 voltha-go/README.md
40 voltha-go/quickstart.md
41 voltha-go/BUILD.md
Zack Williams071eda22019-05-15 18:19:51 -070042
43.. toctree::
44 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080045 :caption: Adapters (outdated)
Zack Williams071eda22019-05-15 18:19:51 -070046
47 voltha-openolt-adapter/README.md
48
49.. toctree::
50 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080051 :caption: VOLTHA-protos (outdated)
Zack Williams071eda22019-05-15 18:19:51 -070052
53 voltha-protos/README.md
54
55.. toctree::
Zack Williams071eda22019-05-15 18:19:51 -070056 :maxdepth: 1
57 :caption: Documentation Notes
58
59 readme
60
61
62
63Indices and tables
64==================
65
66* :ref:`genindex`
67* :ref:`modindex`
68* :ref:`search`