.. image:: ../_static/openl2m_logo.png

====================
Code: Under the Hood
====================

Here are some rudimentary documents that attempt to explain how
OpenL2M works under the hood. We will attempt to flush this out as time
permits. Meanwhile, the source code is your best bet!

The source code (mostly) uses the Google Code Style documentation format.
We also add Python type hints in many places. (Note: work in progress!)

.. toctree::
   :maxdepth: 1
   :caption: Here is what is available at this time:

   requirements.rst
   code_style.rst
   debugging.rst
   code_explained.rst
   authentication.rst
   switches_app/index.rst
   users_app/index.rst
   notices_app/index.rst
   counters_app/index.rst
   drivers/index.rst
   drivers/new-drivers.rst
   templating.rst
   html-layouts.rst
   api/index.rst
   switches_app/graphing_neighbors.rst
   data_model.rst
   documentation.rst