Mirror/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-07-19 14:48:09 -07:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation and manual

Browse Source
This commit is contained in:
Mark Qvist
2022-09-30 18:43:04 +02:00
parent 893a463663
commit f62d9946ac
45 changed files with 5588 additions and 2444 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/manual/_sources/index.rst.txt
+10 -1
View File
@@ -5,6 +5,11 @@ This manual aims to provide you with all the information you need to
understand Reticulum, build networks or develop programs using it, or
to participate in the development of Reticulum itself.
.. only:: html
Table Of Contents
=================
.. toctree::
:maxdepth: 3
@@ -16,9 +21,13 @@ to participate in the development of Reticulum itself.
interfaces
networks
examples
reference
support
.. toctree::
:maxdepth: 2
reference
.. only:: html
docs/manual/_sources/reference.rst.txt
+2 -5
View File
@@ -5,11 +5,8 @@
*************
API Reference
*************
This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their methods and usage. It can be used as a reference while writing applications that utilise Reticulum, or read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
Classes
=========================
Communication over a Reticulum network is achieved using a set of classes exposed by the RNS API.
Communication over Reticulum networks is achieved by using a simple set of classes exposed by the RNS API.
This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their method signatures and usage. It can be used as a reference while writing applications that utilise Reticulum, or it can be read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
.. _api-reticulum: