Added new docs files for 3.0.0

This commit is contained in:
Hemna 2023-01-01 14:49:12 -05:00
parent fe2f7b5b71
commit 29b8764124
11 changed files with 421 additions and 8 deletions

View File

@ -0,0 +1,29 @@
aprsd.clients package
=====================
Submodules
----------
aprsd.clients.aprsis module
---------------------------
.. automodule:: aprsd.clients.aprsis
:members:
:undoc-members:
:show-inheritance:
aprsd.clients.kiss module
-------------------------
.. automodule:: aprsd.clients.kiss
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.clients
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,77 @@
aprsd.cmds package
==================
Submodules
----------
aprsd.cmds.completion module
----------------------------
.. automodule:: aprsd.cmds.completion
:members:
:undoc-members:
:show-inheritance:
aprsd.cmds.dev module
---------------------
.. automodule:: aprsd.cmds.dev
:members:
:undoc-members:
:show-inheritance:
aprsd.cmds.healthcheck module
-----------------------------
.. automodule:: aprsd.cmds.healthcheck
:members:
:undoc-members:
:show-inheritance:
aprsd.cmds.list\_plugins module
-------------------------------
.. automodule:: aprsd.cmds.list_plugins
:members:
:undoc-members:
:show-inheritance:
aprsd.cmds.listen module
------------------------
.. automodule:: aprsd.cmds.listen
:members:
:undoc-members:
:show-inheritance:
aprsd.cmds.send\_message module
-------------------------------
.. automodule:: aprsd.cmds.send_message
:members:
:undoc-members:
:show-inheritance:
aprsd.cmds.server module
------------------------
.. automodule:: aprsd.cmds.server
:members:
:undoc-members:
:show-inheritance:
aprsd.cmds.webchat module
-------------------------
.. automodule:: aprsd.cmds.webchat
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.cmds
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,61 @@
aprsd.conf package
==================
Submodules
----------
aprsd.conf.client module
------------------------
.. automodule:: aprsd.conf.client
:members:
:undoc-members:
:show-inheritance:
aprsd.conf.common module
------------------------
.. automodule:: aprsd.conf.common
:members:
:undoc-members:
:show-inheritance:
aprsd.conf.log module
---------------------
.. automodule:: aprsd.conf.log
:members:
:undoc-members:
:show-inheritance:
aprsd.conf.opts module
----------------------
.. automodule:: aprsd.conf.opts
:members:
:undoc-members:
:show-inheritance:
aprsd.conf.plugin\_common module
--------------------------------
.. automodule:: aprsd.conf.plugin_common
:members:
:undoc-members:
:show-inheritance:
aprsd.conf.plugin\_email module
-------------------------------
.. automodule:: aprsd.conf.plugin_email
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.conf
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,29 @@
aprsd.logging package
=====================
Submodules
----------
aprsd.logging.log module
------------------------
.. automodule:: aprsd.logging.log
:members:
:undoc-members:
:show-inheritance:
aprsd.logging.rich module
-------------------------
.. automodule:: aprsd.logging.rich
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.logging
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,53 @@
aprsd.packets package
=====================
Submodules
----------
aprsd.packets.core module
-------------------------
.. automodule:: aprsd.packets.core
:members:
:undoc-members:
:show-inheritance:
aprsd.packets.packet\_list module
---------------------------------
.. automodule:: aprsd.packets.packet_list
:members:
:undoc-members:
:show-inheritance:
aprsd.packets.seen\_list module
-------------------------------
.. automodule:: aprsd.packets.seen_list
:members:
:undoc-members:
:show-inheritance:
aprsd.packets.tracker module
----------------------------
.. automodule:: aprsd.packets.tracker
:members:
:undoc-members:
:show-inheritance:
aprsd.packets.watch\_list module
--------------------------------
.. automodule:: aprsd.packets.watch_list
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.packets
:members:
:undoc-members:
:show-inheritance:

29
docs/apidoc/aprsd.rpc.rst Normal file
View File

@ -0,0 +1,29 @@
aprsd.rpc package
=================
Submodules
----------
aprsd.rpc.client module
-----------------------
.. automodule:: aprsd.rpc.client
:members:
:undoc-members:
:show-inheritance:
aprsd.rpc.server module
-----------------------
.. automodule:: aprsd.rpc.server
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.rpc
:members:
:undoc-members:
:show-inheritance:

View File

@ -13,6 +13,7 @@ Subpackages
aprsd.logging
aprsd.packets
aprsd.plugins
aprsd.rpc
aprsd.threads
aprsd.utils
aprsd.web
@ -84,14 +85,6 @@ aprsd.plugin\_utils module
:undoc-members:
:show-inheritance:
aprsd.rpc\_server module
------------------------
.. automodule:: aprsd.rpc_server
:members:
:undoc-members:
:show-inheritance:
aprsd.stats module
------------------

View File

@ -0,0 +1,53 @@
aprsd.threads package
=====================
Submodules
----------
aprsd.threads.aprsd module
--------------------------
.. automodule:: aprsd.threads.aprsd
:members:
:undoc-members:
:show-inheritance:
aprsd.threads.keep\_alive module
--------------------------------
.. automodule:: aprsd.threads.keep_alive
:members:
:undoc-members:
:show-inheritance:
aprsd.threads.log\_monitor module
---------------------------------
.. automodule:: aprsd.threads.log_monitor
:members:
:undoc-members:
:show-inheritance:
aprsd.threads.rx module
-----------------------
.. automodule:: aprsd.threads.rx
:members:
:undoc-members:
:show-inheritance:
aprsd.threads.tx module
-----------------------
.. automodule:: aprsd.threads.tx
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.threads
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,61 @@
aprsd.utils package
===================
Submodules
----------
aprsd.utils.counter module
--------------------------
.. automodule:: aprsd.utils.counter
:members:
:undoc-members:
:show-inheritance:
aprsd.utils.fuzzyclock module
-----------------------------
.. automodule:: aprsd.utils.fuzzyclock
:members:
:undoc-members:
:show-inheritance:
aprsd.utils.json module
-----------------------
.. automodule:: aprsd.utils.json
:members:
:undoc-members:
:show-inheritance:
aprsd.utils.objectstore module
------------------------------
.. automodule:: aprsd.utils.objectstore
:members:
:undoc-members:
:show-inheritance:
aprsd.utils.ring\_buffer module
-------------------------------
.. automodule:: aprsd.utils.ring_buffer
:members:
:undoc-members:
:show-inheritance:
aprsd.utils.trace module
------------------------
.. automodule:: aprsd.utils.trace
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: aprsd.utils
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,10 @@
aprsd.web.admin package
=======================
Module contents
---------------
.. automodule:: aprsd.web.admin
:members:
:undoc-members:
:show-inheritance:

18
docs/apidoc/aprsd.web.rst Normal file
View File

@ -0,0 +1,18 @@
aprsd.web package
=================
Subpackages
-----------
.. toctree::
:maxdepth: 4
aprsd.web.admin
Module contents
---------------
.. automodule:: aprsd.web
:members:
:undoc-members:
:show-inheritance: