Merge branch 'master' into release-prep

Author: clint-lawrence

docs/conf.py

@@ -49,7 +49,6 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # Mock imports of the following packages
 # Comments following are the reason for mocking that particular import
@@ -84,7 +83,11 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None

docs/fixate/fixate.config.rst

@@ -25,14 +25,6 @@ fixate.core.common module
    :undoc-members:
    :show-inheritance:
 
-fixate.core.config\_util module
--------------------------------
-
-.. automodule:: fixate.core.config_util
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 fixate.core.control module
 --------------------------
 
@@ -49,14 +41,6 @@ fixate.core.exceptions module
    :undoc-members:
    :show-inheritance:
 
-fixate.core.jig\_mapping module
--------------------------------
-
-.. automodule:: fixate.core.jig_mapping
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 fixate.core.ui module
 ---------------------
 

docs/fixate/fixate.core.rst

@@ -6,27 +6,36 @@ fixate package
    :undoc-members:
    :show-inheritance:
 
+.. autoclass:: VirtualMux
+   :members:
+
+.. autoclass:: VirtualSwitch
+   :members:
+
+.. autoclass:: RelayMatrixMux
+   :members:
+
+.. autoclass:: AddressHandler
+   :members:
+
+.. autoclass:: PinValueAddressHandler
+   :members:
+
+.. autoclass:: MuxGroup
+   :members:
+
+.. autoclass:: JigDriver
+   :members:
+
+.. autofunction:: generate_pin_group
+
+.. autofunction:: generate_relay_matrix_pin_list
+
 Subpackages
 -----------
 
 .. toctree::
    :maxdepth: 4
 
-   fixate.config
    fixate.core
    fixate.drivers
-   fixate.examples
-   fixate.reporting
-   fixate.ui_cmdline
-   fixate.ui_gui_qt
-
-Submodules
-----------
-
-fixate.sequencer module
------------------------
-
-.. automodule:: fixate.sequencer
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/fixate/fixate.examples.rst

@@ -55,6 +55,8 @@ If the package structure changes, then the sphinx-apidocs call above will need t
 
 While the apidoc potentially could be re-run on every build, at least for now I think better to commit in the original run, and then the structure of the api reference can be tweaked to best surface the most important info.
 
+Note: The auto-generated template has been manually modified. Re-running sphinx-apidoc in the future will need to preserve those changes, or incorporate them into the source somehow.
+
 ## docstring style
 
 Autodoc originally used ReStructured Text docstring style, but the [sphix.ext.napoleon](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) extension allows [Google](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html#example-google)/NumPy style.

docs/fixate/fixate.reporting.rst

@@ -535,7 +535,7 @@ def set_pins(self, pins: Collection[Pin]) -> None:
         open it.
 
         :param pins: is a collection of pins that should be made active. All other
-        pins defined by the AddressHandler should be cleared.
+            pins defined by the AddressHandler should be cleared.
         """
         raise NotImplementedError
 
@@ -660,12 +660,12 @@ class MuxGroup:
     Group multiple VirtualMux's, for use in a single Jig Driver.
 
     If a test script, it is expected that MuxGroup will be subclassed, with attributes
-    being each required VirtualMux subclass. This can be done using a dataclass:
+    being each required VirtualMux subclass. This can be done using a dataclass::
 
-    @dataclass
-    class JigMuxGroup(MuxGroup):
-        mux_one: MuxOne = field(default_factory=MuxOne)
-        mux_two: MuxTwo = field(default_factory=MuxTwo)
+        @dataclass
+        class JigMuxGroup(MuxGroup):
+            mux_one: MuxOne = field(default_factory=MuxOne)
+            mux_two: MuxTwo = field(default_factory=MuxTwo)
     """
 
     def get_multiplexers(self) -> list[VirtualMux]:
@@ -817,12 +817,15 @@ def generate_relay_matrix_pin_list(
     """
     Create a pin list for multiple relay matrix modules.
 
-    Each module is allocated 16 pins
-    generate_relay_matrix_pin_list([1,2,3]) ->
-        ("1K1", "1K2", ..., "1K16", "2K1", ..., "2K16", "3K1", ..., "3K16")
+    Each module is allocated 16 pins. For example::
 
-    generate_relay_matrix_pin_list([2,3,1], prefix="RM") ->
-        ("RM2K1", "RM2K2", ..., "RM2K16", "RM3K1", ..., "RM3K16", "RM1K1", ..., "RM1K16")
+        generate_relay_matrix_pin_list([1,2,3]) ->
+            ("1K1", "1K2", ..., "1K16", "2K1", ..., "2K16", "3K1", ..., "3K16")
+
+    You can add a prefix. For example, we ofter use 'RM' for Relay Matrix::
+
+        generate_relay_matrix_pin_list([2,3,1], prefix="RM") ->
+            ("RM2K1", "RM2K2", ..., "RM2K16", "RM3K1", ..., "RM3K16", "RM1K1", ..., "RM1K16")
 
     Combination generate_relay_matrix_pin_list and generate_pin_group to create pins
     as needed for a specific jig configuration.