Added issues section to documentation (#154)

* Added issues.md to documentation

* Removed build_pypi_doc.py (unused)

* Updated roadmap.md

* Removed streaming.md docs (unused)

* Added images to compatibility (current.md)

* Updated siggen_set_duty_cycle() doctrings
- Fixed arg duty tab length.

* Addd 'Issues' section to README.md

* Updated docs versions and pypi.md

Author: JamesPicoTech

README.md

@@ -54,6 +54,9 @@ Once tested, try an [example script from github](https://github.com/picotech/pyP
 ### Full getting started
 [For our full getting started guide, click here to go to our full knowledge base article.](https://www.picotech.com/library/knowledge-bases/oscilloscopes/pypicosdk-get-started)
 
+## Issues
+For details on raising an issue, find information here: [Issue documentation](https://picotech.github.io/pyPicoSDK/dev/issues/)
+
 ## Compatibility
 Current PicoScope support:
 - PicoScope 6000E (ps6000a drivers)
@@ -68,4 +71,4 @@ Current PicoScope support:
 ## Version Control
 pyPicoSDK: 1.6.2
 
-Docs: 0.4.0
+Docs: 0.4.1

build-tools/build_pypi_doc.py

@@ -1,11 +1,13 @@
 <!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
 # Functions available pyPicoSDK v0.1
+![PicoScope 6000E](https://www.picotech.com/images/uploads/series/6800.png)
 ## 6000 (A) API (PicoScope 6000E Series)
  - Simple/Advanced Block Mode
  - Simple/Advanced Rapid Block Mode
  - Signal Generator
  - All other direct driver functions
 
+![PicoScope 3000E](https://www.picotech.com/images/uploads/series/341XE_right_side_w.lights_rgb.webp)
 ## PSOSPA API (PicoScope 3000E Series)
  - Simple/Advanced Block Mode
  - Simple/Advanced Rapid Block Mode

docs/docs/dev/current.md

@@ -0,0 +1,20 @@
+<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
+# Issues
+
+Issues with pyPicoSDK can be placed directly with Pico Technology's tech support team.
+To log an issue email support at:
+
+- Email support: [support@picotech.com](mailto:support@picotech.com?subject=Issue%3A%20pyPicoSDK&body=Issue%20Summary%3A%20%0AEnvironment%20Details%3A%0A%20%20-%20Operating%20system%3A%20%0A%20%20-%20PicoScope%20model%3A%0A%20%20-%20Python%20version%3A%0A%20%20-%20pyPicoSDK%20version%3A%0A%20%20-%20PicoSDK%20version%3A%0ASteps%20to%20reproduce%20issue%3A%0A).
+
+- Contact us via our website: [picotech.com/tech-support/technical-enquiries](https://www.picotech.com/tech-support/technical-enquiries)
+
+Make sure to leave the following information:
+
+- **Issue Summary**: _"Describe the issue in detail."_
+- **Environment Details**
+    - **Operating system:** _"i.e. Windows/macOS/Linux(Ubuntu/Mint)"_
+    - **PicoScope model:** _"i.e. PicoScope 3814E/PicoScope 6824E"_
+    - **Python version:** _"Can be found using `python -V`"_
+    - **pyPicoSDK version:** _"Can be found using `pip list` or `pip freeze`"_
+    - **PicoSDK version:** _"Can be found in SDK docs location per PicoScope"_
+- **Steps to reproduce issue:** _"Detail the steps to arrive at the same."_

docs/docs/dev/issues.md

@@ -4,5 +4,5 @@
 - Streaming examples (inc. downsampling)
 
 ## To-do:
-- PS2000 Driver support
-- PS2000(A) Driver support
+- ps5000(A) API - PicoScope 5000D Series
+- ps4000(A) API - PicoScope 4000A Series

docs/docs/dev/roadmap.md

@@ -39,6 +39,7 @@ nav:
     - ref/constants.md
     - Config/Overrides: ref/configuration.md
   - Development:
+    - Issues: dev/issues.md
     - Changelog: dev/changelog.md
     - Current Support: dev/current.md
     - Upcoming Roadmap: dev/roadmap.md

docs/docs/ref/streaming.md

@@ -51,6 +51,9 @@ Once tested, try an [example script from github](https://github.com/picotech/pyP
 ### Full getting started
 [For our full getting started guide, click here to go to our full knowledge base article.](https://www.picotech.com/library/knowledge-bases/oscilloscopes/pypicosdk-get-started)
 
+## Issues
+For details on raising an issue, find information here: [Issue documentation](https://picotech.github.io/pyPicoSDK/dev/issues/)
+
 ## Compatibility
 Current PicoScope support:
 - PicoScope 6000E (ps6000a drivers)
@@ -65,4 +68,4 @@ Current PicoScope support:
 ## Version Control
 pyPicoSDK: 1.6.2
 
-Docs: 0.4.0
+Docs: 0.4.1

docs/mkdocs.yml

@@ -366,10 +366,10 @@ def siggen_set_frequency(self, frequency:float) -> None:
 
     def siggen_set_duty_cycle(self, duty:float) -> None:
         """
-        Set duty cycle of SigGen in percentage
+        Set duty cycle of SigGen in percentage.
 
         Args:
-                duty cycle (int): Duty cycle in %.
+            duty (float): Duty cycle in %.
         """
         self._call_attr_function(
             'SigGenWaveformDutyCycle',

pypi.md

@@ -1,5 +1,5 @@
 # Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms.
 # Master version file for all scripts.
 # Update these variables and run a build-tool (which will run version_updater.py)
-docs_version = "0.4.0"
+docs_version = "0.4.1"
 package_version = "1.6.2"