Reticulum/docs/source/reference.rst

56 lines
746 B
ReStructuredText

*************
API Reference
*************
This reference guide lists and explains all classes exposed by the RNS API.
Classes
=======
Communication over a Reticulum network in a program is acheived using a set of classes exposed by RNS.
Reticulum
---------
.. automodule:: RNS
:members: Reticulum
Identity
--------
.. automodule:: RNS
:members: Identity
:noindex:
Destination
-----------
.. automodule:: RNS
:members: Destination
:noindex:
Packet
------
.. automodule:: RNS
:members: Packet
:noindex:
Link
----
.. automodule:: RNS
:members: Link
:noindex:
Resource
--------
.. automodule:: RNS
:members: Resource
:noindex:
Transport
---------
.. automodule:: RNS
:members: Transport
:noindex: