diff --git a/Makefile b/Makefile
index 1e20a37..3890f1a 100644
--- a/Makefile
+++ b/Makefile
@@ -21,6 +21,7 @@ clean:
@-rm -rf ./tests/__pycache__
@-rm -rf ./tests/rnsconfig/storage
@-rm -rf ./*.egg-info
+ @make -C docs clean
@echo Done
remove_symlinks:
diff --git a/docs/Reticulum Manual.pdf b/docs/Reticulum Manual.pdf
index 8c47e32..b7805fe 100644
Binary files a/docs/Reticulum Manual.pdf and b/docs/Reticulum Manual.pdf differ
diff --git a/docs/manual/_sources/index.rst.txt b/docs/manual/_sources/index.rst.txt
index bb3e0f5..d61a548 100644
--- a/docs/manual/_sources/index.rst.txt
+++ b/docs/manual/_sources/index.rst.txt
@@ -15,8 +15,8 @@ to participate in the development of Reticulum itself.
hardware
interfaces
networks
- reference
examples
+ reference
support
diff --git a/docs/manual/_sources/reference.rst.txt b/docs/manual/_sources/reference.rst.txt
index e09ec49..27e6eff 100644
--- a/docs/manual/_sources/reference.rst.txt
+++ b/docs/manual/_sources/reference.rst.txt
@@ -1,18 +1,26 @@
+:tocdepth: 4
+
.. _api-main:
*************
API Reference
*************
-This reference guide lists and explains all classes exposed by the RNS API.
+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 RNS.
+Communication over a Reticulum network is achieved using a set of classes exposed by the RNS API.
.. _api-reticulum:
-Reticulum
----------
+.. only:: html
+
+ |start-h3| Reticulum |end-h3|
+
+.. only:: latex
+
+ Reticulum
+ ---------
.. autoclass:: RNS.Reticulum
:members:
@@ -20,64 +28,120 @@ Reticulum
.. _api-identity:
-Identity
---------
+.. only:: html
+
+ |start-h3| Identity |end-h3|
+
+.. only:: latex
+
+ Identity
+ --------
.. autoclass:: RNS.Identity
:members:
.. _api-destination:
-Destination
------------
+.. only:: html
+
+ |start-h3| Destination |end-h3|
+
+.. only:: latex
+
+ Destination
+ -----------
.. autoclass:: RNS.Destination
:members:
.. _api-packet:
-Packet
-------
+.. only:: html
+
+ |start-h3| Packet |end-h3|
+
+.. only:: latex
+
+ Packet
+ ------
.. autoclass:: RNS.Packet(destination, data, create_receipt = True)
:members:
.. _api-packetreceipt:
-Packet Receipt
---------------
+.. only:: html
+
+ |start-h3| Packet Receipt |end-h3|
+
+.. only:: latex
+
+ Packet Receipt
+ --------------
.. autoclass:: RNS.PacketReceipt()
:members:
.. _api-link:
-Link
-----
+.. only:: html
+
+ |start-h3| Link |end-h3|
+
+.. only:: latex
+
+ Link
+ ----
.. autoclass:: RNS.Link(destination, established_callback=None, closed_callback = None)
:members:
.. _api-requestreceipt:
-Request Receipt
----------------
+.. only:: html
+
+ |start-h3| Request Receipt |end-h3|
+
+.. only:: latex
+
+ Request Receipt
+ ---------------
.. autoclass:: RNS.RequestReceipt()
:members:
.. _api-resource:
-Resource
---------
+.. only:: html
+
+ |start-h3| Resource |end-h3|
+
+.. only:: latex
+
+ Resource
+ --------
.. autoclass:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)
:members:
.. _api-transport:
-Transport
----------
+.. only:: html
+
+ |start-h3| Transport |end-h3|
+
+.. only:: latex
+
+ Transport
+ ---------
.. autoclass:: RNS.Transport
- :members:
\ No newline at end of file
+ :members:
+
+.. |start-h3| raw:: html
+
+
+
+.. |end-h3| raw:: html
+
+
\ No newline at end of file
diff --git a/docs/manual/_static/jquery-3.5.1.js b/docs/manual/_static/jquery-3.5.1.js
deleted file mode 100644
index 5093733..0000000
--- a/docs/manual/_static/jquery-3.5.1.js
+++ /dev/null
@@ -1,10872 +0,0 @@
-/*!
- * jQuery JavaScript Library v3.5.1
- * https://jquery.com/
- *
- * Includes Sizzle.js
- * https://sizzlejs.com/
- *
- * Copyright JS Foundation and other contributors
- * Released under the MIT license
- * https://jquery.org/license
- *
- * Date: 2020-05-04T22:49Z
- */
-( function( global, factory ) {
-
- "use strict";
-
- if ( typeof module === "object" && typeof module.exports === "object" ) {
-
- // For CommonJS and CommonJS-like environments where a proper `window`
- // is present, execute the factory and get jQuery.
- // For environments that do not have a `window` with a `document`
- // (such as Node.js), expose a factory as module.exports.
- // This accentuates the need for the creation of a real `window`.
- // e.g. var jQuery = require("jquery")(window);
- // See ticket #14549 for more info.
- module.exports = global.document ?
- factory( global, true ) :
- function( w ) {
- if ( !w.document ) {
- throw new Error( "jQuery requires a window with a document" );
- }
- return factory( w );
- };
- } else {
- factory( global );
- }
-
-// Pass this if window is not defined yet
-} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
-
-// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
-// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
-// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
-// enough that all such attempts are guarded in a try block.
-"use strict";
-
-var arr = [];
-
-var getProto = Object.getPrototypeOf;
-
-var slice = arr.slice;
-
-var flat = arr.flat ? function( array ) {
- return arr.flat.call( array );
-} : function( array ) {
- return arr.concat.apply( [], array );
-};
-
-
-var push = arr.push;
-
-var indexOf = arr.indexOf;
-
-var class2type = {};
-
-var toString = class2type.toString;
-
-var hasOwn = class2type.hasOwnProperty;
-
-var fnToString = hasOwn.toString;
-
-var ObjectFunctionString = fnToString.call( Object );
-
-var support = {};
-
-var isFunction = function isFunction( obj ) {
-
- // Support: Chrome <=57, Firefox <=52
- // In some browsers, typeof returns "function" for HTML