Update version of GitHub action used to build the package (#75)

* fix: Update the version of the GitHub Action used to build the package to fix an issue in that. Also update the readme with some instructions for checking on existing issues.

.github/workflows/package-build.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - uses: hynek/[email protected]
+      - uses: hynek/[email protected].3
         id: build-pkg
       - name: Set up Python
         uses: actions/setup-python@v4

.github/workflows/package-release.yml

@@ -65,7 +65,7 @@ jobs:
           ref: main  # Make sure to check out the latest commit on main, not the original commit that triggered the workflow
           fetch-depth: 0
       - name: Build package
-        uses: hynek/[email protected]
+        uses: hynek/[email protected].3
   upload-testpypi:
     name: Upload package to TestPyPI
     needs: [pypi-build]

.github/workflows/package-testpypi.yml

@@ -18,8 +18,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          # TODO: update to just "x", currently there appears to be a bug in hynek/build-and-inspect-python-package, where it uses an outdated version of typing_extensions.
-          python-version: 3.11
+          python-version: x
           check-latest: true
       - name: Install workflow dependencies
         run: pip install poetry-core tomli tomli_w requests
@@ -33,7 +32,7 @@ jobs:
           python scripts/project_version.py --set-version=$NEW_VERSION
           echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_OUTPUT
       - name: Build package
-        uses: hynek/[email protected]
+        uses: hynek/[email protected].3
     outputs:
       built-version: ${{ steps.create-version.outputs.NEW_VERSION }}
   test-pypi-upload:

README.rst

@@ -262,6 +262,12 @@ See the full documentation at `<https://tm-devices.readthedocs.io>`__
 Maintainers
 -----------
 
+Before reaching out to any maintainers directly, please first check if your issue or question is already
+covered by any `open issues <https://github.com/tektronix/tm_devices/issues>`__. If the issue or
+question you have is not already covered, please
+`file a new issue <https://github.com/tektronix/tm_devices/issues/new/choose>`__ and the
+maintainers will review and respond there.
+
 -  Tektronix [email protected]
 -  Nicholas Felt [email protected]
 

docs/conf.py

@@ -6,7 +6,6 @@
 """
 import os
 import shutil
-import sys
 
 from importlib.metadata import metadata
 from typing import Any, List, Sequence
@@ -52,8 +51,6 @@
     "sphinx_copybutton",
     "sphinx_tippy",
 ]
-if not any(x in " ".join(sys.argv) for x in ("linkcheck", "coverage", "doctest")):
-    extensions.append("sphinxcontrib.relative-link-corrector")
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/requirements.txt

@@ -9,5 +9,4 @@ sphinx-tippy
 sphinx-togglebutton
 sphinxcontrib-jquery
 sphinxcontrib-mermaid
-sphinxcontrib-relative-link-corrector
 urllib3

pyproject.toml

@@ -132,7 +132,6 @@ sphinx-rtd-theme = ">=1.0.0"
 sphinx-tippy = ">=0.4.1"
 sphinx-togglebutton = ">=0.3.2"
 sphinxcontrib-mermaid = ">=0.7.1"
-sphinxcontrib-relative-link-corrector = ">=0.0.5"
 toml-sort = ">=0.23.0"
 tox = ">=4.0"
 tox-gh-actions = ">=3.1.0"