gh4 - Add samples of doxygen, sphinx and breathe

#4

docs/breathe/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7c3f273faa2f32e5919a0465268ecc6b
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/breathe/build/html/_sources/commandModules.rst.txt

@@ -0,0 +1,45 @@
+commandModules package
+======================
+
+Submodules
+----------
+
+commandModules.consoleInterface module
+--------------------------------------
+
+.. automodule:: commandModules.consoleInterface
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+commandModules.serialClass module
+---------------------------------
+
+.. automodule:: commandModules.serialClass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+commandModules.sshConsole module
+--------------------------------
+
+.. automodule:: commandModules.sshConsole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+commandModules.telnetClass module
+---------------------------------
+
+.. automodule:: commandModules.telnetClass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: commandModules
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/breathe/build/html/_sources/core.commandModules.rst.txt

@@ -0,0 +1,45 @@
+core.commandModules package
+===========================
+
+Submodules
+----------
+
+core.commandModules.consoleInterface module
+-------------------------------------------
+
+.. automodule:: core.commandModules.consoleInterface
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.commandModules.serialClass module
+--------------------------------------
+
+.. automodule:: core.commandModules.serialClass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.commandModules.sshConsole module
+-------------------------------------
+
+.. automodule:: core.commandModules.sshConsole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.commandModules.telnetClass module
+--------------------------------------
+
+.. automodule:: core.commandModules.telnetClass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: core.commandModules
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/breathe/build/html/_sources/core.powerModules.rst.txt

@@ -0,0 +1,77 @@
+core.powerModules package
+=========================
+
+Submodules
+----------
+
+core.powerModules.S20control module
+-----------------------------------
+
+.. automodule:: core.powerModules.S20control
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerModules.SLP module
+----------------------------
+
+.. automodule:: core.powerModules.SLP
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerModules.apc module
+----------------------------
+
+.. automodule:: core.powerModules.apc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerModules.apcAos module
+-------------------------------
+
+.. automodule:: core.powerModules.apcAos
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerModules.hs100 module
+------------------------------
+
+.. automodule:: core.powerModules.hs100
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerModules.kasaControl module
+------------------------------------
+
+.. automodule:: core.powerModules.kasaControl
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerModules.none module
+-----------------------------
+
+.. automodule:: core.powerModules.none
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerModules.olimex module
+-------------------------------
+
+.. automodule:: core.powerModules.olimex
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: core.powerModules
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/breathe/build/html/_sources/core.rst.txt

@@ -0,0 +1,134 @@
+core package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   core.commandModules
+   core.powerModules
+
+Submodules
+----------
+
+core.capture module
+-------------------
+
+.. automodule:: core.capture
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.commonRemote module
+------------------------
+
+.. automodule:: core.commonRemote
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.configParser module
+------------------------
+
+.. automodule:: core.configParser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.configParserBase module
+----------------------------
+
+.. automodule:: core.configParserBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.decodeParams module
+------------------------
+
+.. automodule:: core.decodeParams
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.deviceManager module
+-------------------------
+
+.. automodule:: core.deviceManager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.logModule module
+---------------------
+
+.. automodule:: core.logModule
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.outboundClient module
+--------------------------
+
+.. automodule:: core.outboundClient
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.powerControl module
+------------------------
+
+.. automodule:: core.powerControl
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.rackController module
+--------------------------
+
+.. automodule:: core.rackController
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.rcCodes module
+-------------------
+
+.. automodule:: core.rcCodes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.testControl module
+-----------------------
+
+.. automodule:: core.testControl
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.utilities module
+---------------------
+
+.. automodule:: core.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.webpageController module
+-----------------------------
+
+.. automodule:: core.webpageController
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: core
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/breathe/build/html/_sources/index.rst.txt

@@ -0,0 +1,21 @@
+.. python_raft documentation master file, created by
+   sphinx-quickstart on Thu Apr  4 17:17:18 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to python_raft's documentation!
+=======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/breathe/build/html/_sources/modules.rst.txt

@@ -0,0 +1,7 @@
+framework
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   core