Small fixes (#83)

* Updated build_docs.py
 - Enhanced docstrings
 - Added debug info

* Added pypicosdk/ to mkdocs watchlist

* Fixed get_all_enumerated_units.
- Now won't raise error when a scope is disconnected

* Added example to convert_time_axis()

Author: JamesPicoTech

build-tools/build_docs.py

@@ -13,12 +13,16 @@
     raise FileNotFoundError('docs/ does not exist in this directory')
 
 ref_dir = 'docs/docs/ref/'
-copy_dir = 'psospa'
+copy_dir = 'psospa' # Main copy dir (truth source)
+
+# Paste directory list with an exclude for certain files
 paste_dir_list = [
-    'ps6000a'
+    {'name': 'ps6000a', 'exclude': ['led.md',]}
 ]
 
+# List of files to copy from copy_dir to paste_dir
 file_list = [
+    # 'init.md', Do not include init.md
     'buffers.md',
     'captures.md', 
     'channel.md',
@@ -30,11 +34,23 @@
     'setup.md',
     'siggen.md',
     'trigger.md',
+    'led.md',
 ]
 
-for paste_dir in paste_dir_list:
+# Report any files that aren't included for info
+all_files = os.listdir(os.path.join(ref_dir, copy_dir))
+missing_files = [f for f in all_files if f not in file_list]
+print('Files not included in copy:', missing_files)
+
+# Copy each file to each paste_dir 
+for paste_dir_dict in paste_dir_list:
+    paste_dir = paste_dir_dict['name']
+    exclude_list = paste_dir_dict['exclude']
     for f in file_list:
+        if f in exclude_list:
+            continue
         copy_fp = os.path.join(ref_dir, copy_dir, f)
         paste_fp = os.path.join(ref_dir, paste_dir, f)
+        print(f'Copying {f} to {paste_fp}')
         with open(copy_fp) as f: text = f.read()
         with open(paste_fp, 'w') as f: f.write(text.replace(copy_dir, paste_dir))

docs/mkdocs.yml

@@ -42,6 +42,8 @@ nav:
     - Current Support: dev/current.md
     - Upcoming Roadmap: dev/roadmap.md
 
+watch:
+  - '../pypicosdk'
 
 plugins:
 - include-markdown

pypicosdk/pypicosdk.py

@@ -15,11 +15,23 @@
 )
 
 def get_all_enumerated_units() -> tuple[int, list[str]]:
-    """Enumerate all supported PicoScope units."""
+    """Enumerate all supported PicoScope units.
+    
+    Returns: 
+        Tuple containing number of units and a list of unit serials.
+
+    Examples:
+        >>> from pypicosdk import get_all_enumerated_units
+        >>> n_units, unit_list = get_all_enumerated_units()
+        >>> print(n_units, unit_list)
+    """
     n_units = 0
     unit_serial: list[str] = []
     for scope in [ps6000a(), psospa()]:
-        units = scope.get_enumerated_units()
+        try:
+            units = scope.get_enumerated_units()
+        except PicoSDKException:
+            continue
         n_units += units[0]
         unit_serial += units[1].split(',')
     return n_units, unit_serial
@@ -79,6 +91,10 @@ def convert_time_axis(
     Returns:
         A tuple containing the new NumPy array scaled to the target units,
         and a string representing the target units.
+
+    Examples:
+        >>> from pypicosdk import convert_time_axis
+        >>> new_time_axis = convert_time_axis(old_time_axis, 'ns', 'ms')
     """
     diff = time_standard_form_m[convert_units] - time_standard_form_m[current_units]
     time_axis = np.multiply(time_axis, 10**diff)