blob: 83d408d2feae1d7b6b3eb7435afffaf709a1e1b0 [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
Andrea Campanella4cf8ba02020-01-21 18:01:59 +010018
Andrea Campanella92bd59b2020-01-30 17:26:32 +010019 voltctl/README.md
Andrea Campanella4cf8ba02020-01-21 18:01:59 +010020
21.. toctree::
Zack Williamse377eae2019-12-20 16:40:38 -070022 :maxdepth: 2
23 :caption: BBSim
24
25 bbsim/docs/source/index.rst
26
27.. toctree::
28 :maxdepth: 1
29 :caption: Release Notes
30 :glob:
31
32 release_notes/*
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080033
34.. toctree::
35 :maxdepth: 1
Andy Bavier5dee6ae2020-01-29 16:03:40 -070036 :caption: Testing
37
38 testing/index.rst
Andrea Campanella92bd59b2020-01-30 17:26:32 +010039 voltha-system-tests/README.md
Andy Bavier5dee6ae2020-01-29 16:03:40 -070040
41.. toctree::
42 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080043 :caption: VOLTHA Core (outdated)
Zack Williams071eda22019-05-15 18:19:51 -070044
45 voltha-go/README.md
46 voltha-go/quickstart.md
47 voltha-go/BUILD.md
Zack Williams071eda22019-05-15 18:19:51 -070048
49.. toctree::
50 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080051 :caption: Adapters (outdated)
Zack Williams071eda22019-05-15 18:19:51 -070052
53 voltha-openolt-adapter/README.md
54
55.. toctree::
56 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -080057 :caption: VOLTHA-protos (outdated)
Zack Williams071eda22019-05-15 18:19:51 -070058
59 voltha-protos/README.md
60
61.. toctree::
Zack Williams071eda22019-05-15 18:19:51 -070062 :maxdepth: 1
63 :caption: Documentation Notes
64
65 readme
66
67
68
69Indices and tables
70==================
71
72* :ref:`genindex`
73* :ref:`modindex`
74* :ref:`search`