Tm-devices

Merged Pull Requests

- docs: Add a copy button to the code blocks in the documentation ([211](https://github.com/tektronix/tm_devices/pull/211))
- docs: Update mkdocs-ezglossary-plugin version used for building docs ([210](https://github.com/tektronix/tm_devices/pull/210))
- docs: Add styling for a new method label ([209](https://github.com/tektronix/tm_devices/pull/209))

Added

- Added a click to copy button to all code blocks.

Fixed

- Updated `mkdocs-ezglossary-plugin` to a version that allows linking to glossary entries from the
home page of documentation that is hosted on ReadtheDocs.

---

Merged Pull Requests

- ci: Revert python-semantic-release version bump since the GitHub Action no longer properly signs commits ([208](https://github.com/tektronix/tm_devices/pull/208))
- gh-actions(deps): bump the gh-actions-dependencies group with 2 updates ([207](https://github.com/tektronix/tm_devices/pull/207))
- Update contribution guide to remove outdated instructions ([205](https://github.com/tektronix/tm_devices/pull/205))
- fix: Update Changelog template to prevent pre-commit failures. when creating new versions with python-semantic-version ([204](https://github.com/tektronix/tm_devices/pull/204))

Fixed

- Updated the changelog template to not cause `pre-commit` failures when it is used to update the changelog.
- Updated the readme to properly render on PyPI.

Removed

- Removed outdated instructions from the contribution guide.

---

Merged Pull Requests

- fix: Update release notes generator script to account for markdown formatting changes ([203](https://github.com/tektronix/tm_devices/pull/203))
- Update package to point to ReadtheDocs for official documentation ([201](https://github.com/tektronix/tm_devices/pull/201))
- Fix ReadtheDocs builds by installing nodejs ([200](https://github.com/tektronix/tm_devices/pull/200))
- docs: Switch from Sphinx to Mkdocs for building documentation. ([11](https://github.com/tektronix/tm_devices/pull/11))
- gh-actions(deps): bump python-semantic-release/python-semantic-release ([197](https://github.com/tektronix/tm_devices/pull/197))
- python-deps(deps): bump the python-dependencies group with 2 updates ([192](https://github.com/tektronix/tm_devices/pull/192))
- gh-actions(deps): bump the gh-actions-dependencies group with 2 updates ([191](https://github.com/tektronix/tm_devices/pull/191))
- gh-actions(deps): bump the gh-actions-dependencies group with 3 updates ([190](https://github.com/tektronix/tm_devices/pull/190))
- python-deps(deps-dev): update pyright requirement from 1.1.356 to 1.1.357 in the python-dependencies group ([189](https://github.com/tektronix/tm_devices/pull/189))

Changed

- Switched from using `sphinx` to `mkdocs` for building the documentation. This enables building the
documentation in under 10 minutes while using less than 6 GB of RAM and saving almost 2 GB of
disk space. Fixes [77](https://github.com/tektronix/tm_devices/issues/77).
- Switched from GitHub Pages to ReadtheDocs for official documentation hosting.

Fixed

- Fixed the Readme to display as intended in GitHub and PyPI while maintaining all functionality in
the generated documentation site.

---

Merged Pull Requests

- Updated the get_acquisition_data example to select source for the measurement. ([187](https://github.com/tektronix/tm_devices/issues/187))

Changed

- Updated get_acquisition_data example to select source for the measurement.

---

Merged Pull Requests

- Update SBOM scanning workflow to be able to upload artifacts to GitHub releases ([186](https://github.com/tektronix/tm_devices/issues/186))

Security

- Updated the workflow that creates SBOMs to be able to upload the SBOM as an artifact to a GitHub release.

---

Merged Pull Requests

- Fix packaging workflows to correctly gate on the repo name. ([185](https://github.com/tektronix/tm_devices/issues/185))
- Convert PyPI upload workflows into reusable workflows. ([184](https://github.com/tektronix/tm_devices/issues/184))
- ci: Update docformatter version, it no longer causes issues. ([182](https://github.com/tektronix/tm_devices/issues/182))
- Add test results to job summary and pull request comments ([181](https://github.com/tektronix/tm_devices/issues/181))
- Convert workflows into reusable workflows ([178](https://github.com/tektronix/tm_devices/issues/178))
- Update file checker workflow ([179](https://github.com/tektronix/tm_devices/issues/179))
- gh-actions(deps): bump the gh-actions-dependencies group with 2 updates ([177](https://github.com/tektronix/tm_devices/issues/177))
- python-deps(deps-dev): bump the python-dependencies group with 1 update ([176](https://github.com/tektronix/tm_devices/issues/176))
- Update admonition in readme to fix a glitch/bug in GitHub web UI ([174](https://github.com/tektronix/tm_devices/issues/174))
- Update supported devices and VISA backends in the readme ([170](https://github.com/tektronix/tm_devices/issues/170))
- fix: Updated the measurement source selection command for the MDO3K, MDO4K, MSO4K and DPO4K models to work properly. ([173](https://github.com/tektronix/tm_devices/issues/173))
- ci: Update codecov-action to v4. ([140](https://github.com/tektronix/tm_devices/issues/140))
- Handle Visa IO Error on first connection ([172](https://github.com/tektronix/tm_devices/issues/172))
- Misc. workflow updates ([171](https://github.com/tektronix/tm_devices/issues/171))
- gh-actions(deps): Bump the gh-actions-dependencies group with 1 update ([158](https://github.com/tektronix/tm_devices/issues/158))
- python-deps(deps): Bump the python-dependencies group with 2 updates ([159](https://github.com/tektronix/tm_devices/issues/159))
- gh-actions(deps): Bump the gh-actions-dependencies group with 2 updates ([166](https://github.com/tektronix/tm_devices/issues/166))
- ci: Update documentation builds to use node.js version 20. ([163](https://github.com/tektronix/tm_devices/issues/163))
- refactor: Update the type aliases used by the `DeviceManager` add/get methods to return `TypeVar`s with default values that are bound to the appropriate device type. ([162](https://github.com/tektronix/tm_devices/issues/162))
- ci: Add a step to upload the sarif file as a workflow artifact. ([157](https://github.com/tektronix/tm_devices/issues/157))
- refactor: Update the get_model_series() method to only warn the user if the model isn't contained in the list of supported models. ([156](https://github.com/tektronix/tm_devices/issues/156))
- test: Update tox to test building the package in a unique environment to prevent race conditions when running tox environments in parallel. ([155](https://github.com/tektronix/tm_devices/issues/155))
- ci: Add permissions to write security events for the SBOM scan. ([154](https://github.com/tektronix/tm_devices/issues/154))
- Add SBOM generation and scanning workflow ([153](https://github.com/tektronix/tm_devices/issues/153))

Added

- Added TekVISA as one of the VISA backends supported.

Changed

- Updated the `get_model_series()` function to only warn the user if the model is not found in the `SupportedModels` enumeration. This also eliminates false warnings during unit tests.

Fixed

- Updated the measurement source selection command for the MDO3K, MDO4K, MSO4K and DPO4K models to work properly.

---