updated docs

rsnodgrass · Mar 5, 2024 · eb24adb · eb24adb
1 parent d453131
commit eb24adb
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -138,4 +138,4 @@ Example URL formats supported by pyserial:
 - [Earlier McIntosh control in Home Assistant](https://community.home-assistant.io/t/need-help-using-rs232-to-control-a-receiver/95210/8)
 - https://drivers.control4.com/solr/drivers/browse?q=mcintosh
 - [RS232 to USB cable](https://www.amazon.com/RS232-to-USB/dp/B0759HSLP1?tag=carreramfi-20)
-
+* [IO Ninja](https://ioninja.com/)
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -10,8 +10,8 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'PyAVControl' # TBD
-copyright = '2024 Ryan Snodgrass'
+project = 'PyAVControl'
+copyright = '2024, Ryan Snodgrass'
 author = 'Ryan Snodgrass'
 release = '0.0.1'
 
@@ -34,3 +34,8 @@
 
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+
+# -- Generate documentation for Dynamic classes ------------------------------
+# see https://pypi.org/project/sphinx-autorun/#description
+
+import pyavcontrol.library.docs
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,6 +8,16 @@ 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.
 
+
+.. image:: https://img.shields.io/badge/Donate-PayPal-green.svg
+   :target: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=WREP29UDAMB6G
+   :alt: Done
+
+.. image:: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg
+   :target: https://buymeacoffee.com/DYks67r
+   :alt: Buy Me A Coffee
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

diff --git a/pyavcontrol/data/README.md b/pyavcontrol/data/README.md
@@ -17,6 +17,7 @@ This indicates that there should be a build pipeline that converts the definitio
 * support access to the intrefaces via JSON by clients (no need to implement complex config parsing for new languages IF it is acceptable to tradeoff "compiling" the definitions down into a large repository of JSON files)
 * separate the definition from the runtime dependency
 * schema/limited type checking
+* ability to add comments
 
 #### Config Languages Considered
 
@@ -30,7 +31,7 @@ This indicates that there should be a build pipeline that converts the definitio
 
 And of course raw formats, which was the initial implementation, but quickly abandoned due to the sheer volume of files and duplicate config needed to support minute differences between a vast array of physical device features:
 
-* JSON: most compatible and frequently used for data interfaces
+* JSON: most compatible and frequently used for data interfaces; no ability to add comments
 * YAML: more readable than json, with some limited support for references
 * TOML
 

diff --git a/pyavcontrol/data/rcl/mcintosh/mcintosh_mx170.rcl b/pyavcontrol/data/rcl/mcintosh/mcintosh_mx170.rcl