Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 1 | VOLTHA Documentation |
2 | ==================== | ||||
3 | |||||
4 | .. image:: images/VOLTHA_LOGO.png | ||||
5 | |||||
Matteo Scandolo | 1f5530b | 2019-12-17 10:12:31 -0800 | [diff] [blame] | 6 | Welcome to the VOLTHA project documentation. |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 7 | |
8 | .. toctree:: | ||||
9 | :maxdepth: 1 | ||||
Matteo Scandolo | 1f5530b | 2019-12-17 10:12:31 -0800 | [diff] [blame] | 10 | :caption: Overview |
Zack Williams | e377eae | 2019-12-20 16:40:38 -0700 | [diff] [blame] | 11 | :glob: |
Matteo Scandolo | 1f5530b | 2019-12-17 10:12:31 -0800 | [diff] [blame] | 12 | |
Zack Williams | e377eae | 2019-12-20 16:40:38 -0700 | [diff] [blame] | 13 | overview/* |
14 | |||||
15 | .. toctree:: | ||||
Andrea Campanella | 4cf8ba0 | 2020-01-21 18:01:59 +0100 | [diff] [blame^] | 16 | :maxdepth: 1 |
17 | :caption: Voltctl | ||||
18 | :glob: | ||||
19 | |||||
20 | voltctl | ||||
21 | |||||
22 | .. toctree:: | ||||
Zack Williams | e377eae | 2019-12-20 16:40:38 -0700 | [diff] [blame] | 23 | :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 Scandolo | 1f5530b | 2019-12-17 10:12:31 -0800 | [diff] [blame] | 34 | |
35 | .. toctree:: | ||||
36 | :maxdepth: 1 | ||||
37 | :caption: VOLTHA Core (outdated) | ||||
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 38 | |
39 | voltha-go/README.md | ||||
40 | voltha-go/quickstart.md | ||||
41 | voltha-go/BUILD.md | ||||
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 42 | |
43 | .. toctree:: | ||||
44 | :maxdepth: 1 | ||||
Matteo Scandolo | 1f5530b | 2019-12-17 10:12:31 -0800 | [diff] [blame] | 45 | :caption: Adapters (outdated) |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 46 | |
47 | voltha-openolt-adapter/README.md | ||||
48 | |||||
49 | .. toctree:: | ||||
50 | :maxdepth: 1 | ||||
Matteo Scandolo | 1f5530b | 2019-12-17 10:12:31 -0800 | [diff] [blame] | 51 | :caption: VOLTHA-protos (outdated) |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 52 | |
53 | voltha-protos/README.md | ||||
54 | |||||
55 | .. toctree:: | ||||
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 56 | :maxdepth: 1 |
57 | :caption: Documentation Notes | ||||
58 | |||||
59 | readme | ||||
60 | |||||
61 | |||||
62 | |||||
63 | Indices and tables | ||||
64 | ================== | ||||
65 | |||||
66 | * :ref:`genindex` | ||||
67 | * :ref:`modindex` | ||||
68 | * :ref:`search` |