mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-04-27 08:09:59 -07:00
Added basic documentation structure
This commit is contained in:
56
docs/source/reference.rst
Normal file
56
docs/source/reference.rst
Normal 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:
|
||||
Reference in New Issue
Block a user