Merge remote-tracking branch 'origin/main' into dependabot/pip/vws-python-mock-2025.2.18

Author: adamtheturtle

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['3.12']
+        python-version: ['3.13']
         platform: [ubuntu-latest, windows-latest]
 
     runs-on: ${{ matrix.platform }}
@@ -27,6 +27,9 @@ jobs:
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
 
       - name: Run tests
         run: |

.github/workflows/lint.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['3.12']
+        python-version: ['3.13']
         platform: [ubuntu-latest, windows-latest]
 
     runs-on: ${{ matrix.platform }}
@@ -27,6 +27,9 @@ jobs:
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
 
       - name: Lint
         run: |

.github/workflows/publish-site.yml

@@ -0,0 +1,27 @@
+---
+name: Deploy documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: ${{ github.ref_name == 'main' && 'github-pages' || 'development' }}
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - id: deployment
+        uses: sphinx-notes/pages@v3
+        with:
+          documentation_path: docs/source
+          pyproject_extras: dev
+          python_version: '3.13'
+          sphinx_build_options: -W
+          publish: ${{ github.ref_name == 'main' }}

.github/workflows/release.yml

@@ -20,10 +20,6 @@ jobs:
       # This is needed for https://github.com/stefanzweifel/git-auto-commit-action.
       contents: write
 
-    strategy:
-      matrix:
-        python-version: ['3.12']
-
     steps:
       - uses: actions/checkout@v4
         with:
@@ -39,6 +35,9 @@ jobs:
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
 
       - name: Calver calculate version
         uses: StephaneBour/actions-calver@master
@@ -69,6 +68,8 @@ jobs:
         with:
           commit_message: Bump CHANGELOG
           file_pattern: CHANGELOG.rst
+          # Error if there are no changes.
+          skip_dirty_check: true
 
       - name: Bump version and push tag
         id: tag_version
@@ -83,6 +84,7 @@ jobs:
         uses: ncipollo/release-action@v1
         with:
           tag: ${{ steps.tag_version.outputs.new_tag }}
+          makeLatest: true
           name: Release ${{ steps.tag_version.outputs.new_tag }}
           body: ${{ steps.tag_version.outputs.changelog }}
 

README.rst

@@ -1,4 +1,4 @@
-|Build Status| |codecov| |PyPI| |Documentation Status|
+|Build Status| |codecov| |PyPI|
 
 vws-python
 ==========
@@ -67,15 +67,12 @@ Getting Started
 Full Documentation
 ------------------
 
-See the `full
-documentation <https://vws-python.readthedocs.io/en/latest>`__.
+See the `full documentation <https://vws-python.github.io/vws-python/>`__.
 
 .. |Build Status| image:: https://github.com/VWS-Python/vws-python/actions/workflows/ci.yml/badge.svg?branch=main
    :target: https://github.com/VWS-Python/vws-python/actions
 .. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/VWS-Python/vws-python
 .. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
    :target: https://badge.fury.io/py/VWS-Python
-.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest
-   :target: https://vws-python.readthedocs.io/en/latest/?badge=latest
-.. |minimum-python-version| replace:: 3.12
+.. |minimum-python-version| replace:: 3.13

docs/source/conf.py

@@ -4,11 +4,19 @@
 """
 
 import importlib.metadata
+from pathlib import Path
 
 from packaging.specifiers import SpecifierSet
+from sphinx_pyproject import SphinxConfig
 
-project = "VWS-Python"
-author = "Adam Dangoor"
+_pyproject_file = Path(__file__).parent.parent.parent / "pyproject.toml"
+_pyproject_config = SphinxConfig(
+    pyproject_file=_pyproject_file,
+    config_overrides={"version": None},
+)
+
+project = _pyproject_config.name
+author = _pyproject_config.author
 
 extensions = [
     "sphinx_copybutton",
@@ -29,19 +37,6 @@
 # https://sphinx-copybutton.readthedocs.io/en/latest/use.html#automatic-exclusion-of-prompts-from-the-copies.
 copybutton_exclude = ".linenos, .gp"
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# Use ``importlib.metadata.version`` as per
-# https://setuptools-scm.readthedocs.io/en/latest/usage/#usage-from-sphinx
-version = importlib.metadata.version(distribution_name=project)
-# This method of getting the release from the version goes hand in hand with
-# the ``post-release`` versioning scheme chosen in the ``setuptools-scm``
-# configuration.
-release = version.split(sep=".post")[0]
-
-
 project_metadata = importlib.metadata.metadata(distribution_name=project)
 requires_python = project_metadata["Requires-Python"]
 specifiers = SpecifierSet(specifiers=requires_python)
@@ -69,7 +64,6 @@
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "VWSPYTHONdoc"
-autoclass_content = "init"
 intersphinx_mapping = {
     "python": (f"https://docs.python.org/{minimum_python_version}", None),
 }
@@ -88,7 +82,6 @@
 
 rst_prolog = f"""
 .. |project| replace:: {project}
-.. |release| replace:: {release}
 .. |minimum-python-version| replace:: {minimum_python_version}
 .. |github-owner| replace:: VWS-Python
 .. |github-repository| replace:: vws-python

docs/source/index.rst

@@ -110,11 +110,10 @@ To write unit tests for code which uses this library, without using your Vuforia
         assert matching_targets[0].target_id == target_id
 
 There are some differences between the mock and the real Vuforia.
-See https://vws-python-mock.readthedocs.io/en/latest/differences-to-vws.html for details.
+See https://vws-python.github.io/vws-python-mock/differences-to-vws for details.
 
 .. _VWS Python Mock: https://github.com/VWS-Python/vws-python-mock
 
-
 Reference
 ---------
 

pyproject.toml

@@ -19,15 +19,15 @@ license = { file = "LICENSE" }
 authors = [
     { name = "Adam Dangoor", email = "adamdangoor@gmail.com" },
 ]
-requires-python = ">=3.12"
+requires-python = ">=3.13"
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Web Environment",
     "License :: OSI Approved :: MIT License",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: POSIX",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 dynamic = [
     "version",
@@ -43,7 +43,7 @@ optional-dependencies.dev = [
     "check-manifest==0.50",
     "deptry==0.23.0",
     "doc8==1.1.2",
-    "doccmd==2025.2.17",
+    "doccmd==2025.2.20.7",
     "docformatter==1.7.5",
     "freezegun==1.5.1",
     "furo==2024.8.6",
@@ -62,15 +62,16 @@ optional-dependencies.dev = [
     "pytest==8.3.4",
     "pytest-cov==6.0.0",
     "pyyaml==6.0.2",
-    "ruff==0.9.6",
+    "ruff==0.9.7",
     # We add shellcheck-py not only for shell scripts and shell code blocks,
     # but also because having it installed means that ``actionlint-py`` will
     # use it to lint shell commands in GitHub workflow files.
     "shellcheck-py==0.10.0.1",
     "shfmt-py==3.7.0.1",
-    "sphinx==8.1.3",
+    "sphinx==8.2.0",
     "sphinx-copybutton==0.5.2",
     "sphinx-lint==1.0.0",
+    "sphinx-pyproject==0.3.0",
     "sphinx-substitution-extensions==2025.2.19",
     "sphinxcontrib-spelling==8.0.1",
     "sybil==9.1.0",
@@ -81,7 +82,7 @@ optional-dependencies.dev = [
     "yamlfix==1.17.0",
 ]
 optional-dependencies.release = [ "check-wheel-contents==0.6.1" ]
-urls.Documentation = "https://vws-python.readthedocs.io/en/latest/"
+urls.Documentation = "https://vws-python.github.io/vws-python/"
 urls.Source = "https://github.com/VWS-Python/vws-python"
 
 [tool.setuptools]
@@ -282,7 +283,6 @@ ignore = [
     ".yamlfmt",
     "*.enc",
     ".pre-commit-config.yaml",
-    "readthedocs.yaml",
     "CHANGELOG.rst",
     "CODE_OF_CONDUCT.rst",
     "CONTRIBUTING.rst",
@@ -312,7 +312,7 @@ pep621_dev_dependency_groups = [
 [tool.pyproject-fmt]
 indent = 4
 keep_full_version = true
-max_supported_python = "3.12"
+max_supported_python = "3.13"
 
 [tool.pytest.ini_options]
 

readthedocs.yaml

@@ -90,6 +90,7 @@ rgb
 str
 timestamp
 todo
+traceback
 travis
 txt
 unmocked