rt/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-10-26 19:01:53 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added basic documentation structure

Browse source
This commit is contained in:
Mark Qvist 2021-05-16 17:36:50 +02:00
parent e8f7e4a5b7
commit f698e32ecc
6 changed files with 658 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

56
docs/source/reference.rst Normal file
View file

@ -0,0 +1,56 @@
*************
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: