fixed doc generation

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

Hide file tree

Showing 6 changed files with 11 additions and 33 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -14,12 +14,13 @@ help:
 
 .PHONY: help Makefile
 
-update:
-	pip3 install -r ../requirements-dev.txt 
+# Update all the supported models from the library sources
+update_supported_models:
+	pip3 install --quiet -r ../requirements-dev.txt 
 	./update-supported-models
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+%: Makefile update_supported_models
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
diff --git a/docs/source/pyavcontrol.library.rst b/docs/source/pyavcontrol.library.rst
@@ -28,14 +28,6 @@ pyavcontrol.library.model module
    :undoc-members:
    :show-inheritance:
 
-pyavcontrol.library.schema module
----------------------------------
-
-.. automodule:: pyavcontrol.library.schema
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 pyavcontrol.library.yaml\_library module
 ----------------------------------------
 

diff --git a/docs/source/pyavcontrol.rst b/docs/source/pyavcontrol.rst
@@ -14,38 +14,23 @@ Subpackages
 Submodules
 ----------
 
-pyavcontrol.config module
+pyavcontrol.helper module
 -------------------------
 
-.. automodule:: pyavcontrol.config
+.. automodule:: pyavcontrol.helper
    :members:
    :undoc-members:
    :show-inheritance:
 
-pyavcontrol.const module
+pyavcontrol.utils 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
+.. automodule:: pyavcontrol.utils
    :members:
    :undoc-members:
    :show-inheritance:
 
+
 Module contents
 ---------------
 

diff --git a/pyavcontrol/client/base.py b/pyavcontrol/client/base.py
@@ -8,7 +8,7 @@
 
 from ..config import CONFIG
 from ..connection import DeviceConnection
-from ..core import (
+from ..utils import (
     camel_case,
     generate_docs_for_action,
     missing_keys_in_dict,

diff --git a/pyavcontrol/core.py → pyavcontrol/utils.py b/pyavcontrol/core.py → pyavcontrol/utils.py
diff --git a/test-dynamic-client.py b/test-dynamic-client.py
@@ -28,7 +28,7 @@
 
 from pyavcontrol import DeviceClient, DeviceModelLibrary
 from pyavcontrol.connection import NullConnection
-from pyavcontrol.core import (
+from pyavcontrol.utils import (
     camel_case,
     extract_named_regex,
     get_fstring_vars,