.. _api_reference:

=============
API Reference
=============

This page is a single entry point to generated API content from Python
docstrings/autodoc and C++ Doxygen output.

Python API
==========

Use the Python module and symbol indices to browse all exposed Python API
objects documented by Sphinx:

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

Primary Python API sections:

.. toctree::
   :maxdepth: 2

   /api/python/index

C++ API
=======

Use the section class indexes for curated C++ APIs, grouped by namespace.

``rogue::hardware``

* :doc:`/api/cpp/hardware/axi/index`
* :doc:`/api/cpp/hardware/raw/index`

``rogue::interfaces``

* :doc:`/api/cpp/interfaces/memory/index`
* :doc:`/api/cpp/interfaces/stream/index`

``rogue::protocols``

* :doc:`/api/cpp/protocols/batcher/index`
* :doc:`/api/cpp/protocols/packetizer/index`
* :doc:`/api/cpp/protocols/rssi/index`
* :doc:`/api/cpp/protocols/srp/index`
* :doc:`/api/cpp/protocols/udp/index`
* :doc:`/api/cpp/protocols/xilinx/index`

``rogue::utilities``

* :doc:`/api/cpp/utilities/compression/index`
* :doc:`/api/cpp/utilities/fileio/index`
* :doc:`/api/cpp/utilities/prbs/index`

.. toctree::
   :hidden:
   :maxdepth: 1

   /api/cpp/hardware/axi/index
   /api/cpp/hardware/raw/index
   /api/cpp/interfaces/memory/index
   /api/cpp/interfaces/stream/index
   /api/cpp/protocols/batcher/index
   /api/cpp/protocols/packetizer/index
   /api/cpp/protocols/rssi/index
   /api/cpp/protocols/srp/index
   /api/cpp/protocols/udp/index
   /api/cpp/protocols/xilinx/index
   /api/cpp/utilities/compression/index
   /api/cpp/utilities/fileio/index
   /api/cpp/utilities/prbs/index