VOLTHA Documentation
====================

.. image:: images/VOLTHA_LOGO.png

Welcome to the VOLTHA project documentation.

.. toctree::
   :maxdepth: 1
   :caption: Overview

   overview/deploy-physical.rst
   overview/deploy-virtual.rst
   overview/development_loop.rst
   overview/troubleshooting.rst
   overview/known_issues.rst
   overview/contribute.rst

.. toctree::
   :maxdepth: 1
   :caption: VOLTHA Core (outdated)

   voltha-go/README.md
   voltha-go/quickstart.md
   voltha-go/BUILD.md
   voltha-go/python/adapters/BUILD_ENV.md
   voltha-go/python/adapters/README.md
   voltha-go/python/cli/docs/README.md

.. toctree::
   :maxdepth: 1
   :caption: Adapters (outdated)

   voltha-openolt-adapter/README.md

.. toctree::
   :maxdepth: 1
   :caption: VOLTHA-protos (outdated)

   voltha-protos/README.md

.. toctree::
   :maxdepth: 2
   :caption: BBSim

   bbsim/docs/source/index.rst

.. toctree::
   :maxdepth: 1
   :caption: Documentation Notes

   readme


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`