update

rsnodgrass · Feb 27, 2024 · b03727b · b03727b
1 parent e37615f
commit b03727b
Show file tree

Hide file tree

Showing 8 changed files with 167 additions and 3 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -10,7 +10,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'PyAVControl'
+project = 'PyAVControl' # TBD
 copyright = '2024 Ryan Snodgrass'
 author = 'Ryan Snodgrass'
 release = '0.0.1'

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,9 +3,11 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to pyavcontrol docs!
+Welcome to PyAVControl
 =======================================
 
+Library created to control a wide variety of A/V equipment which expose text-based control protocols over RS232, USB serial connections, and/or remote IP sockets.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+pyavcontrol
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   pyavcontrol
diff --git a/docs/source/pyavcontrol.client.rst b/docs/source/pyavcontrol.client.rst
@@ -0,0 +1,37 @@
+pyavcontrol.client package
+==========================
+
+Submodules
+----------
+
+pyavcontrol.client.async\_client module
+---------------------------------------
+
+.. automodule:: pyavcontrol.client.async_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.client.base module
+------------------------------
+
+.. automodule:: pyavcontrol.client.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.client.sync\_client module
+--------------------------------------
+
+.. automodule:: pyavcontrol.client.sync_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pyavcontrol.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pyavcontrol.connection.rst b/docs/source/pyavcontrol.connection.rst
@@ -0,0 +1,29 @@
+pyavcontrol.connection package
+==============================
+
+Submodules
+----------
+
+pyavcontrol.connection.async\_connection module
+-----------------------------------------------
+
+.. automodule:: pyavcontrol.connection.async_connection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.connection.sync\_connection module
+----------------------------------------------
+
+.. automodule:: pyavcontrol.connection.sync_connection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pyavcontrol.connection
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pyavcontrol.library.rst b/docs/source/pyavcontrol.library.rst
@@ -0,0 +1,53 @@
+pyavcontrol.library package
+===========================
+
+Submodules
+----------
+
+pyavcontrol.library.base module
+-------------------------------
+
+.. automodule:: pyavcontrol.library.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.library.docs module
+-------------------------------
+
+.. automodule:: pyavcontrol.library.docs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.library.model module
+--------------------------------
+
+.. automodule:: pyavcontrol.library.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.library.schema module
+---------------------------------
+
+.. automodule:: pyavcontrol.library.schema
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.library.yaml\_library module
+----------------------------------------
+
+.. automodule:: pyavcontrol.library.yaml_library
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pyavcontrol.library
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pyavcontrol.rst b/docs/source/pyavcontrol.rst
@@ -7,9 +7,45 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
+   pyavcontrol.client
+   pyavcontrol.connection
+   pyavcontrol.library
+
 Submodules
 ----------
 
+pyavcontrol.config module
+-------------------------
+
+.. automodule:: pyavcontrol.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.const module
+------------------------
+
+.. automodule:: pyavcontrol.const
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.core module
+-----------------------
+
+.. automodule:: pyavcontrol.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyavcontrol.helper module
+-------------------------
+
+.. automodule:: pyavcontrol.helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git a/docs/source/supported.md b/docs/source/supported.md
@@ -1,7 +1,7 @@
 
 # Supported Equipment
 
-*This is autogenerated from pyavcontrol's DeviceModel library (using build-supported-models-doc).*
+*This is autogenerated from PyAVControl's DeviceModel library (using build-supported-models-doc).*