Updated docs

This commit is contained in:
Mark Qvist 2021-05-16 23:13:56 +02:00
parent 522204d8a5
commit cd0e177080
3 changed files with 19 additions and 1 deletions

View File

@ -35,6 +35,8 @@ extensions = [
#'sphinx.ext.autosectionlabel',
]
autodoc_member_order = 'bysource'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

View File

@ -6,6 +6,7 @@ Examples
A number of examples are included in the source distribution of Reticulum.
You can use these examples to learn how to write your own programs.
.. _example-minimal:
Minimal
=======
@ -16,6 +17,8 @@ a Reticulum network from your program. In about five lines of code, you will
have the Reticulum Network Stack initialised, and ready to pass traffic in your
program.
.. _example-announce:
Announce
========
This example can be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Announce.py>`_.
@ -24,6 +27,7 @@ The *Announce* example builds upon the previous example by exploring how to
announce a destination on the network, and how to let your program receive
notifications about announces from relevant destinations.
.. _example-broadcast:
Broadcast
=========
@ -32,6 +36,8 @@ This example can be found at `<https://github.com/markqvist/Reticulum/blob/maste
The *Broadcast* example explores how to transmit plaintext broadcast messages
over the network.
.. _example-echo:
Echo
====
This example can be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py>`_.
@ -48,6 +54,8 @@ This example can be found at `<https://github.com/markqvist/Reticulum/blob/maste
The *Link* example explores establishing an encrypted link to a remote
destination, and passing traffic back and forth over the link.
.. _example-filetransfer:
Filetransfer
============
This example can be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py>`_.

View File

@ -5,7 +5,7 @@ API Reference
*************
This reference guide lists and explains all classes exposed by the RNS API.
Primary Interface Classes
Classes
=========================
Communication over a Reticulum network in a program is acheived using a set of
classes exposed by RNS.
@ -43,6 +43,14 @@ Packet
.. autoclass:: RNS.Packet
:members:
.. _api-packetreceipt:
Packet Receipt
--------------
.. autoclass:: RNS.PacketReceipt
:members:
.. _api-link:
Link