Updated documentation

This commit is contained in:
Mark Qvist
2021-05-17 16:10:52 +02:00
parent 87a2c6b1fc
commit 7176fdb71d
34 changed files with 3 additions and 0 deletions

View File

@@ -0,0 +1,75 @@
.. _api-main:
*************
API Reference
*************
This reference guide lists and explains all classes exposed by the RNS API.
Classes
=========================
Communication over a Reticulum network is achieved using a set of classes exposed by RNS.
.. _api-reticulum:
Reticulum
---------
.. autoclass:: RNS.Reticulum
:members:
.. _api-identity:
Identity
--------
.. autoclass:: RNS.Identity
:members:
.. _api-destination:
Destination
-----------
.. autoclass:: RNS.Destination
:members:
.. _api-packet:
Packet
------
.. autoclass:: RNS.Packet
:members:
.. _api-packetreceipt:
Packet Receipt
--------------
.. autoclass:: RNS.PacketReceipt
:members:
.. _api-link:
Link
----
.. autoclass:: RNS.Link
:members:
.. _api-resource:
Resource
--------
.. autoclass:: RNS.Resource
:members:
.. _api-transport:
Transport
---------
.. autoclass:: RNS.Transport
:members: