From cd0e1770807b28a32c96d558134a00fbb91cc930 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 16 May 2021 23:13:56 +0200 Subject: [PATCH] Updated docs --- docs/source/conf.py | 2 ++ docs/source/examples.rst | 8 ++++++++ docs/source/reference.rst | 10 +++++++++- 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index ba07a95..5cc83c8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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'] diff --git a/docs/source/examples.rst b/docs/source/examples.rst index 10a0da0..b5e2e69 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -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 ``_. @@ -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 ``_. @@ -48,6 +54,8 @@ This example can be found at ``_. diff --git a/docs/source/reference.rst b/docs/source/reference.rst index 0f8a653..d545310 100644 --- a/docs/source/reference.rst +++ b/docs/source/reference.rst @@ -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