1
0
mirror of https://github.com/craigerl/aprsd.git synced 2026-06-02 06:04:42 -04:00

Reworked README and documentation

This commit is contained in:
2025-12-10 14:57:12 -05:00
parent 23ad059707
commit 5ece2a10ef
19 changed files with 4021 additions and 831 deletions
+21
View File
@@ -0,0 +1,21 @@
aprsd.client.drivers.lib package
================================
Submodules
----------
aprsd.client.drivers.lib.aprslib module
---------------------------------------
.. automodule:: aprsd.client.drivers.lib.aprslib
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.client.drivers.lib
:members:
:undoc-members:
:show-inheritance:
+35 -3
View File
@@ -1,6 +1,14 @@
aprsd.client.drivers package
============================
Subpackages
-----------
.. toctree::
:maxdepth: 4
aprsd.client.drivers.lib
Submodules
----------
@@ -20,10 +28,34 @@ aprsd.client.drivers.fake module
:undoc-members:
:show-inheritance:
aprsd.client.drivers.kiss module
--------------------------------
aprsd.client.drivers.kiss\_common module
----------------------------------------
.. automodule:: aprsd.client.drivers.kiss
.. automodule:: aprsd.client.drivers.kiss_common
:members:
:undoc-members:
:show-inheritance:
aprsd.client.drivers.registry module
------------------------------------
.. automodule:: aprsd.client.drivers.registry
:members:
:undoc-members:
:show-inheritance:
aprsd.client.drivers.serialkiss module
--------------------------------------
.. automodule:: aprsd.client.drivers.serialkiss
:members:
:undoc-members:
:show-inheritance:
aprsd.client.drivers.tcpkiss module
-----------------------------------
.. automodule:: aprsd.client.drivers.tcpkiss
:members:
:undoc-members:
:show-inheritance:
+2 -34
View File
@@ -12,42 +12,10 @@ Subpackages
Submodules
----------
aprsd.client.aprsis module
aprsd.client.client module
--------------------------
.. automodule:: aprsd.client.aprsis
:members:
:undoc-members:
:show-inheritance:
aprsd.client.base module
------------------------
.. automodule:: aprsd.client.base
:members:
:undoc-members:
:show-inheritance:
aprsd.client.factory module
---------------------------
.. automodule:: aprsd.client.factory
:members:
:undoc-members:
:show-inheritance:
aprsd.client.fake module
------------------------
.. automodule:: aprsd.client.fake
:members:
:undoc-members:
:show-inheritance:
aprsd.client.kiss module
------------------------
.. automodule:: aprsd.client.kiss
.. automodule:: aprsd.client.client
:members:
:undoc-members:
:show-inheritance:
+29
View File
@@ -0,0 +1,29 @@
aprsd.packets.filters package
=============================
Submodules
----------
aprsd.packets.filters.dupe\_filter module
-----------------------------------------
.. automodule:: aprsd.packets.filters.dupe_filter
:members:
:undoc-members:
:show-inheritance:
aprsd.packets.filters.packet\_type module
-----------------------------------------
.. automodule:: aprsd.packets.filters.packet_type
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.packets.filters
:members:
:undoc-members:
:show-inheritance:
+16
View File
@@ -1,6 +1,14 @@
aprsd.packets package
=====================
Subpackages
-----------
.. toctree::
:maxdepth: 4
aprsd.packets.filters
Submodules
----------
@@ -20,6 +28,14 @@ aprsd.packets.core module
:undoc-members:
:show-inheritance:
aprsd.packets.filter module
---------------------------
.. automodule:: aprsd.packets.filter
:members:
:undoc-members:
:show-inheritance:
aprsd.packets.log module
------------------------
+8
View File
@@ -36,6 +36,14 @@ aprsd.threads.rx module
:undoc-members:
:show-inheritance:
aprsd.threads.service module
----------------------------
.. automodule:: aprsd.threads.service
:members:
:undoc-members:
:show-inheritance:
aprsd.threads.stats module
--------------------------
+8
View File
@@ -44,6 +44,14 @@ aprsd.utils.objectstore module
:undoc-members:
:show-inheritance:
aprsd.utils.package module
--------------------------
.. automodule:: aprsd.utils.package
:members:
:undoc-members:
:show-inheritance:
aprsd.utils.ring\_buffer module
-------------------------------