From 4ee7d9c5d4d61aa04b772b82b6f27e12af82866b Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Tue, 21 May 2024 23:45:14 -0400
Subject: [PATCH 01/35] Bump to dev version

---
 src/sphobjinv/version.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/sphobjinv/version.py b/src/sphobjinv/version.py
index 7f12092..d9a0888 100644
--- a/src/sphobjinv/version.py
+++ b/src/sphobjinv/version.py
@@ -29,4 +29,4 @@
 
 """
 
-__version__ = "2.3.1.1"
+__version__ = "2.3.2.dev0"

From 0d7d513cdc80237eed5fa3f5b809096b57bc54a1 Mon Sep 17 00:00:00 2001
From: James Addison <jay@jp-hosting.net>
Date: Wed, 2 Oct 2024 11:37:20 +0100
Subject: [PATCH 02/35] Fixup: add missing call operator in template

The `super` keyword used in a statement in the HTML footer
template was missing parentheses to perform a method call; this
caused the template rendering to emit a Python string describing
the parent template object, instead of rendering the parent
template as intended.
---
 doc/source/_templates/footer.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/source/_templates/footer.html b/doc/source/_templates/footer.html
index 1ee7734..e519d56 100644
--- a/doc/source/_templates/footer.html
+++ b/doc/source/_templates/footer.html
@@ -2,7 +2,7 @@
 
 {%-block extrafooter %}
 
-{{ super }}
+{{ super() }}
 
 <br /><br />
 

From e54ecb3ff4cf6e2e2e37b80d05597f74b06d2d2d Mon Sep 17 00:00:00 2001
From: James Addison <jay@jp-hosting.net>
Date: Wed, 2 Oct 2024 15:18:58 +0100
Subject: [PATCH 03/35] Add CHANGELOG entry

---
 CHANGELOG.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b6f7c2f..c20092d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,17 @@ and this project follows an extension of
 fourth number represents an administrative maintenance release with no code
 changes.
 
+### Unreleased
+
+#### Fixed
+
+  * The `super` keyword used in a statement in the HTML footer
+    template was missing parentheses to perform a method call; this
+    caused the template rendering to emit a Python string describing
+    the parent template object, instead of rendering the parent
+    template as intended.
+    ([#298](https://github.com/bskinn/sphobjinv/issues/298))
+
 ### [2.3.1.1] - 2024-05-21
 
 #### Tests

From d2c0abc11d3e17221727dcc48fc3575a25136813 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 00:01:37 -0500
Subject: [PATCH 04/35] Bump env versions in tox.ini

---
 tox.ini | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/tox.ini b/tox.ini
index 3176583..c189a4b 100644
--- a/tox.ini
+++ b/tox.ini
@@ -3,21 +3,21 @@ minversion=2.0
 isolated_build=True
 envlist=
     # Test all Python versions on latest lib versions
-    py3{8,9,10,11,12}-sphx_latest-attrs_latest-jsch_latest
+    py3{9,10,11,12,13}-sphx_latest-attrs_latest-jsch_latest
     # Test leading Python version on current in-repo dev lib versions
-    py312-sphx_dev-attrs_dev-jsch_dev
+    py313-sphx_dev-attrs_dev-jsch_dev
     # Scan across Sphinx versions
-    py312-sphx_{1_6_x,1_x,2_x,4_x,5_x,6_xdev}-attrs_latest-jsch_latest
+    py313-sphx_{1_6_x,1_x,2_x,4_x,5_x,6_x,7_x,dev}-attrs_latest-jsch_latest
     # sphx_3_x is incompatible with py310 due to a typing import. Test on py39 instead.
     py39-sphx_3_x-attrs_latest-jsch_latest
     # Scan attrs versions
-    py312-sphx_latest-attrs_{19_2,19_3,20_1,20_2,20_3,21_2,21_3,22_2,dev}-jsch_latest
+    py313-sphx_latest-attrs_{19_2,19_3,20_1,20_2,20_3,21_2,21_3,22_2,23_2,dev}-jsch_latest
     # Scan jsonschema versions
-    py312-sphx_latest-attrs_latest-jsch_{3_0,3_x,4_0,4_8,4_14,dev}
+    py313-sphx_latest-attrs_latest-jsch_{3_0,3_x,4_0,4_8,4_14,4_20,dev}
     # Earliest supported Python and lib versions all together
-    py38-sphx_1_6_x-attrs_19_2-jsch_3_0
+    py39-sphx_1_6_x-attrs_19_2-jsch_3_0
     # Spot matrix of early Python, Sphinx, attrs versions
-    py3{8,9}-sphx_{1,2}_x-attrs_{19,20}_2-jsch_latest
+    py3{9,10}-sphx_{1,2}_x-attrs_{19,20}_2-jsch_latest
     # Test the specific Sphinx threshold cases where behavior changed
     py312-sphx_{2_3_1,2_4_0,3_2_1,3_3_0,3_4_0}-attrs_latest-jsch_latest
     # Simple 'does the sdist install' check
@@ -40,6 +40,7 @@ deps=
     sphx_4_x:     sphinx<5
     sphx_5_x:     sphinx<6
     sphx_6_x:     sphinx<7
+    sphx_7_x:     sphinx<8
     sphx_2_3_1:   sphinx==2.3.1
     sphx_2_4_0:   sphinx==2.4.0
     sphx_3_2_1:   sphinx==3.2.1
@@ -56,6 +57,7 @@ deps=
     attrs_21_2:   attrs==21.2
     attrs_21_3:   attrs==21.3
     attrs_22_2:   attrs==22.2
+    attrs_23_2:   attrs==23.2
     attrs_latest: attrs
     attrs_dev:    git+https://github.com/python-attrs/attrs
 
@@ -64,6 +66,7 @@ deps=
     jsch_4_0:     jsonschema<4.1
     jsch_4_8:     jsonschema<4.9
     jsch_4_14:    jsonschema<4.15
+    jsch_4_20:    jsonschema<4.21
     jsch_latest:  jsonschema
     jsch_dev:     git+https://github.com/Julian/jsonschema
 
@@ -80,11 +83,11 @@ deps=
 [testenv:linux]
 platform=linux
 basepython=
+    py313: python3.13
     py312: python3.12
     py311: python3.11
     py310: python3.10
     py39: python3.9
-    py38: python3.8
 
 [testenv:flake8]
 skip_install=True

From 6740597d1bd17097ead9c6fc832ec2b696524b63 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 00:01:56 -0500
Subject: [PATCH 05/35] Update python_requires & classifiers

In pyproject.toml
---
 pyproject.toml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 14a04df..5f35b59 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -21,11 +21,11 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Documentation",
     "Topic :: Documentation :: Sphinx",
     "Topic :: Software Development",
@@ -34,7 +34,7 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
 ]
 keywords = ["sphinx", "sphinx-doc", "inventory", "manager", "inspector"]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = [
     "attrs>=19.2",
     "certifi",

From cad274f881aa34bf9051b2822e4dc09a67b68b15 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 00:02:21 -0500
Subject: [PATCH 06/35] Update pipeline/workflow Python versions

---
 .github/workflows/ci_tests.yml |  6 +++---
 azure-pipelines.yml            | 24 ++++++++++++------------
 azure-sdisttest.yml            |  2 +-
 3 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml
index 9597cfd..78a33f5 100644
--- a/.github/workflows/ci_tests.yml
+++ b/.github/workflows/ci_tests.yml
@@ -4,7 +4,7 @@ on: push
 
 jobs:
   all_checks:
-    name: Run all tests, lints, etc. (Python 3.11)
+    name: Run all tests, lints, etc. (Python 3.12)
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
 
@@ -15,7 +15,7 @@ jobs:
     - name: Install Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.11'
+        python-version: '3.12'
         cache: 'pip'
         cache-dependency-path: |
           requirements-ci.txt
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ['3.8', '3.9', '3.10', '3.12']
+        python: ['3.9', '3.10', '3.11', '3.13']
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
 
     steps:
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index 64f0c2a..889ff24 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -23,7 +23,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - task: Cache@2
       inputs:
@@ -55,7 +55,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - task: Cache@2
       inputs:
@@ -79,8 +79,6 @@ stages:
   - template: azure-coretest.yml
     parameters:
       pythons:
-        py38:
-          spec: '3.8'
         py39:
           spec: '3.9'
         py310:
@@ -89,6 +87,8 @@ stages:
           spec: '3.11'
         py312:
           spec: '3.12'
+        py313:
+          spec: '3.13'
         pypy3:
           spec: 'pypy3'
       platforms: [linux]
@@ -96,8 +96,6 @@ stages:
   - template: azure-coretest.yml
     parameters:
       pythons:
-        py38:
-          spec: '3.8'
         py39:
           spec: '3.9'
         py310:
@@ -106,6 +104,8 @@ stages:
           spec: '3.11'
         py312:
           spec: '3.12'
+        py313:
+          spec: '3.13'
       platforms: [windows, macOs]
 
   - template: azure-sdisttest.yml
@@ -124,7 +124,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - task: Cache@2
       inputs:
@@ -150,7 +150,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - task: Cache@2
       inputs:
@@ -176,7 +176,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - script: pip install -r requirements-ci.txt
       displayName: Install CI requirements
@@ -205,7 +205,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - task: Cache@2
       inputs:
@@ -231,7 +231,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - task: Cache@2
       inputs:
@@ -263,7 +263,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
 
     - task: Cache@2
       inputs:
diff --git a/azure-sdisttest.yml b/azure-sdisttest.yml
index f7448ea..4106a2e 100644
--- a/azure-sdisttest.yml
+++ b/azure-sdisttest.yml
@@ -11,7 +11,7 @@ jobs:
   steps:
   - task: UsePythonVersion@0
     inputs:
-      versionSpec: '3.11'
+      versionSpec: '3.12'
 
   - task: Cache@2
     inputs:

From ee9b466cec4e17aa5c83e3b424e223234f0b7b43 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 22:51:07 -0500
Subject: [PATCH 07/35] Move linkcheck from CI to tox

If it's going to falsely break the builds on the regular, it's
not worth it.
---
 .github/workflows/ci_tests.yml | 5 -----
 tox.ini                        | 9 +++++++++
 2 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml
index 78a33f5..9697251 100644
--- a/.github/workflows/ci_tests.yml
+++ b/.github/workflows/ci_tests.yml
@@ -46,11 +46,6 @@ jobs:
         cd doc
         make doctest
 
-    - name: Run docs link check
-      run: |
-        cd doc
-        make linkcheck
-
     - name: Lint code
       run: tox -e flake8
 
diff --git a/tox.ini b/tox.ini
index c189a4b..0f8071d 100644
--- a/tox.ini
+++ b/tox.ini
@@ -24,6 +24,8 @@ envlist=
     sdist_install
     # Lints
     flake8
+    # Sphinx link check
+    linkcheck
 
 [testenv]
 commands=
@@ -108,6 +110,13 @@ deps=interrogate
 commands=
     interrogate {posargs} conftest.py tests src
 
+[testenv:linkcheck]
+skip_install=True
+deps=-rrequirements-dev.txt
+commands=
+    cd doc
+    make linkcheck
+
 [testenv:sdist_install]
 commands=
     python -Werror -c "import sphobjinv"

From febf654a6dbf014caf347bcf6e50290e5bd8b1c7 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 23:24:12 -0500
Subject: [PATCH 08/35] Update flake8 version in requirements-flake8.txt

---
 requirements-flake8.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/requirements-flake8.txt b/requirements-flake8.txt
index 3151acc..7694372 100644
--- a/requirements-flake8.txt
+++ b/requirements-flake8.txt
@@ -1,5 +1,5 @@
 colorama
-flake8>=5,<6
+flake8>=6.1.0  # Avoids pycodestyle bug @ v6.0 w.r.t re.py
 flake8-2020
 flake8-absolute-import
 flake8-bandit

From 782ece6a7f586e36a2ea29a111e6a05254a1c577 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 23:37:10 -0500
Subject: [PATCH 09/35] Add GITHUB_TOKEN to Azure Pipelines def

---
 azure-pipelines.yml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index 889ff24..37e9aba 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -6,6 +6,7 @@ pr:
 
 variables:
   pip_cache_dir: $(Pipeline.Workspace)/.pip
+  GITHUB_TOKEN: $(GITHUB_TOKEN)
 
 
 stages:
@@ -24,6 +25,8 @@ stages:
     - task: UsePythonVersion@0
       inputs:
         versionSpec: '3.12'
+      env:
+        GITHUB_TOKEN: $(GITHUB_TOKEN)
 
     - task: Cache@2
       inputs:

From 5f20248ce85476ffed7ac701442dae11a98dc413 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 23:40:14 -0500
Subject: [PATCH 10/35] Try removing the pipeline variable

---
 azure-pipelines.yml | 1 -
 1 file changed, 1 deletion(-)

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index 37e9aba..d2114b6 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -6,7 +6,6 @@ pr:
 
 variables:
   pip_cache_dir: $(Pipeline.Workspace)/.pip
-  GITHUB_TOKEN: $(GITHUB_TOKEN)
 
 
 stages:

From a7cb2109a1be5320b86776ba1d08691c427d2432 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 23:41:28 -0500
Subject: [PATCH 11/35] Remove linkcheck step from Azure Pipelines

---
 azure-pipelines.yml | 26 --------------------------
 1 file changed, 26 deletions(-)

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index d2114b6..95ae041 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -198,32 +198,6 @@ stages:
       displayName: Run README doctests
 
 
-  - job: linkcheck
-    displayName: Run docs link-check suite
-
-    pool:
-      vmImage: 'Ubuntu-latest'
-
-    steps:
-    - task: UsePythonVersion@0
-      inputs:
-        versionSpec: '3.12'
-
-    - task: Cache@2
-      inputs:
-        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
-        restoreKeys: |
-          pip | "$(Agent.OS)"
-        path: $(pip_cache_dir)
-      displayName: Cache pip
-
-    - script: pip install . -r requirements-rtd.txt
-      displayName: Install doc requirements and local project
-
-    - script: cd doc; make linkcheck
-      displayName: Run link check
-
-
   - job: testdir_coverage
     displayName: Confirm all test code was executed
 

From 8fd570fafdb3d68307471ece67fe2113405f709e Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 23:49:01 -0500
Subject: [PATCH 12/35] Switch GITHUB_TOKEN to the right job def

---
 azure-pipelines.yml | 2 --
 azure-sdisttest.yml | 1 +
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index 95ae041..c5675ef 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -24,8 +24,6 @@ stages:
     - task: UsePythonVersion@0
       inputs:
         versionSpec: '3.12'
-      env:
-        GITHUB_TOKEN: $(GITHUB_TOKEN)
 
     - task: Cache@2
       inputs:
diff --git a/azure-sdisttest.yml b/azure-sdisttest.yml
index 4106a2e..bc916b9 100644
--- a/azure-sdisttest.yml
+++ b/azure-sdisttest.yml
@@ -12,6 +12,7 @@ jobs:
   - task: UsePythonVersion@0
     inputs:
       versionSpec: '3.12'
+      githubToken: $(GITHUB_TOKEN)
 
   - task: Cache@2
     inputs:

From 4bf9b8a41695289c28236077d4241e185918ead9 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 23:51:40 -0500
Subject: [PATCH 13/35] Change to env variable

---
 azure-sdisttest.yml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/azure-sdisttest.yml b/azure-sdisttest.yml
index bc916b9..7988024 100644
--- a/azure-sdisttest.yml
+++ b/azure-sdisttest.yml
@@ -12,7 +12,8 @@ jobs:
   - task: UsePythonVersion@0
     inputs:
       versionSpec: '3.12'
-      githubToken: $(GITHUB_TOKEN)
+    env:
+      GITHUB_TOKEN: $(GITHUB_TOKEN)
 
   - task: Cache@2
     inputs:

From 26fb91ce37afe09f8380a09605f1c22fe7628a66 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Mon, 9 Dec 2024 23:56:25 -0500
Subject: [PATCH 14/35] No, *this* time put it in the right place, eesh

---
 azure-coretest.yml  | 1 +
 azure-sdisttest.yml | 2 --
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/azure-coretest.yml b/azure-coretest.yml
index 9de7ca7..d778cc2 100644
--- a/azure-coretest.yml
+++ b/azure-coretest.yml
@@ -28,6 +28,7 @@ jobs:
         inputs:
           versionSpec: '${{ python.value.spec }}'
           architecture: 'x64'
+          githubToken: $(GITHUB_TOKEN)
         displayName: Use cached ${{ coalesce(python.value.name, python.key) }} for tests.
 
       - task: Cache@2
diff --git a/azure-sdisttest.yml b/azure-sdisttest.yml
index 7988024..4106a2e 100644
--- a/azure-sdisttest.yml
+++ b/azure-sdisttest.yml
@@ -12,8 +12,6 @@ jobs:
   - task: UsePythonVersion@0
     inputs:
       versionSpec: '3.12'
-    env:
-      GITHUB_TOKEN: $(GITHUB_TOKEN)
 
   - task: Cache@2
     inputs:

From bf657775c93f38809dd4c2bfdc7af43d2aa0e2df Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Tue, 10 Dec 2024 00:03:12 -0500
Subject: [PATCH 15/35] Add test var-printing job

---
 azure-pipelines.yml | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index c5675ef..b4c43de 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -14,6 +14,17 @@ stages:
   displayName: Check code quality
 
   jobs:
+  - job: test_var
+    displayName: Check for the test variable
+
+    pool:
+      vmImage: 'Ubunto-latest'
+
+    steps:
+    - script: echo $TEST_VAR
+      displayName: Echo var
+
+
   - job: flake8
     displayName: Run all flake8 checks
 

From 2966f486bdbbe3a82b2993ca829862b52a07be1f Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Tue, 10 Dec 2024 00:04:24 -0500
Subject: [PATCH 16/35] Helps when you spell it correctly

---
 azure-pipelines.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index b4c43de..ac08bc9 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -18,7 +18,7 @@ stages:
     displayName: Check for the test variable
 
     pool:
-      vmImage: 'Ubunto-latest'
+      vmImage: 'Ubuntu-latest'
 
     steps:
     - script: echo $TEST_VAR

From 297220f7af7078236ef1f801f4d046207a35e328 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Tue, 10 Dec 2024 00:09:30 -0500
Subject: [PATCH 17/35] Add group reference and adjust existing var

ChatGPT did *not* have the whole story. Not anywhere close.
---
 azure-pipelines.yml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index ac08bc9..ef45682 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -5,7 +5,9 @@ pr:
     - stable
 
 variables:
-  pip_cache_dir: $(Pipeline.Workspace)/.pip
+  - group: default-variables
+  - name: pip_cache_dir
+    value: $(Pipeline.Workspace)/.pip
 
 
 stages:

From 1e3c3c641beec9bf33cd5c5378cf8d9e12a56f98 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Tue, 10 Dec 2024 00:12:47 -0500
Subject: [PATCH 18/35] Revert test-env-print changes and add group to coretest

---
 azure-coretest.yml  |  3 +++
 azure-pipelines.yml | 15 +--------------
 2 files changed, 4 insertions(+), 14 deletions(-)

diff --git a/azure-coretest.yml b/azure-coretest.yml
index d778cc2..45fbf9b 100644
--- a/azure-coretest.yml
+++ b/azure-coretest.yml
@@ -5,6 +5,9 @@ parameters:
   pythons: []
   platforms: []
 
+variables:
+- group: default-variables
+
 jobs:
 - ${{ each python in parameters.pythons }}:
   - ${{ each platform in parameters.platforms }}:
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index ef45682..c5675ef 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -5,9 +5,7 @@ pr:
     - stable
 
 variables:
-  - group: default-variables
-  - name: pip_cache_dir
-    value: $(Pipeline.Workspace)/.pip
+  pip_cache_dir: $(Pipeline.Workspace)/.pip
 
 
 stages:
@@ -16,17 +14,6 @@ stages:
   displayName: Check code quality
 
   jobs:
-  - job: test_var
-    displayName: Check for the test variable
-
-    pool:
-      vmImage: 'Ubuntu-latest'
-
-    steps:
-    - script: echo $TEST_VAR
-      displayName: Echo var
-
-
   - job: flake8
     displayName: Run all flake8 checks
 

From 4921edacfd60c93c7c854cc8c764d92b405326d5 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Tue, 10 Dec 2024 00:15:19 -0500
Subject: [PATCH 19/35] Move variable def back to the main YAML

Did _not_ like it inside the coretest template
---
 azure-coretest.yml  | 3 ---
 azure-pipelines.yml | 4 +++-
 2 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/azure-coretest.yml b/azure-coretest.yml
index 45fbf9b..d778cc2 100644
--- a/azure-coretest.yml
+++ b/azure-coretest.yml
@@ -5,9 +5,6 @@ parameters:
   pythons: []
   platforms: []
 
-variables:
-- group: default-variables
-
 jobs:
 - ${{ each python in parameters.pythons }}:
   - ${{ each platform in parameters.platforms }}:
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index c5675ef..1e4fb72 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -5,7 +5,9 @@ pr:
     - stable
 
 variables:
-  pip_cache_dir: $(Pipeline.Workspace)/.pip
+- group: default-variables
+- name: pip_cache_dir
+  value: $(Pipeline.Workspace)/.pip
 
 
 stages:

From 7f1a8579ec358c8d241edc601d46860926f75392 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Sat, 14 Dec 2024 09:21:13 -0500
Subject: [PATCH 20/35] Rename to .readthedocs.yaml

Irritatingly strict
---
 .readthedocs.yml => .readthedocs.yaml | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename .readthedocs.yml => .readthedocs.yaml (100%)

diff --git a/.readthedocs.yml b/.readthedocs.yaml
similarity index 100%
rename from .readthedocs.yml
rename to .readthedocs.yaml

From 815f0e24e13cebbd7fd041ce7f75bb5c56763db7 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Sat, 14 Dec 2024 10:43:16 -0500
Subject: [PATCH 21/35] Convert tox linkcheck to explicit sh call

---
 tox.ini | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/tox.ini b/tox.ini
index 0f8071d..7995729 100644
--- a/tox.ini
+++ b/tox.ini
@@ -113,9 +113,10 @@ commands=
 [testenv:linkcheck]
 skip_install=True
 deps=-rrequirements-dev.txt
+allowlist_externals=
+    sh
 commands=
-    cd doc
-    make linkcheck
+    sh -c 'cd doc && make linkcheck'
 
 [testenv:sdist_install]
 commands=

From df2e8ef74aa439b0de900d9c9ae5309191c26631 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Sat, 14 Dec 2024 12:43:30 -0500
Subject: [PATCH 22/35] Switch to better tox dir change

---
 tox.ini | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/tox.ini b/tox.ini
index 7995729..265fe53 100644
--- a/tox.ini
+++ b/tox.ini
@@ -114,9 +114,10 @@ commands=
 skip_install=True
 deps=-rrequirements-dev.txt
 allowlist_externals=
-    sh
+    make
+changedir=doc
 commands=
-    sh -c 'cd doc && make linkcheck'
+    make linkcheck
 
 [testenv:sdist_install]
 commands=

From b4f6fadd0de650318a0b82d6de8dda7aac3d0cb5 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:12:39 -0500
Subject: [PATCH 23/35] Remove .pre-commit-config.yaml

Slows commits, is an extra setup step, and really isn't *all* that
helpful since the CI is set up to fail early if things don't lint.
---
 .pre-commit-config.yaml | 18 ------------------
 1 file changed, 18 deletions(-)
 delete mode 100644 .pre-commit-config.yaml

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
deleted file mode 100644
index f52668c..0000000
--- a/.pre-commit-config.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 'v4.3.0'
-    hooks:
-    -   id: trailing-whitespace
-    -   id: end-of-file-fixer
-    -   id: check-yaml
-    -   id: check-added-large-files
--   repo: https://github.com/psf/black
-    rev: '22.10.0'
-    hooks:
-    -   id: black
--   repo: https://github.com/tox-dev/pyproject-fmt
-    rev: '0.3.5'
-    hooks:
-    -   id: pyproject-fmt

From 8f453b9e5f382a4f3ab0c082355931b2e374285a Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:15:02 -0500
Subject: [PATCH 24/35] Add flake8-black

Want to catch nonblackened code
---
 requirements-flake8.txt | 1 +
 1 file changed, 1 insertion(+)

diff --git a/requirements-flake8.txt b/requirements-flake8.txt
index 7694372..a2e76cd 100644
--- a/requirements-flake8.txt
+++ b/requirements-flake8.txt
@@ -3,6 +3,7 @@ flake8>=6.1.0  # Avoids pycodestyle bug @ v6.0 w.r.t re.py
 flake8-2020
 flake8-absolute-import
 flake8-bandit
+flake8-black
 flake8-bugbear
 flake8-builtins
 flake8-comprehensions

From 8d7780d4f587985e3a8128b438cb848958d93adb Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:15:29 -0500
Subject: [PATCH 25/35] Blacken

---
 conftest.py                | 1 -
 src/sphobjinv/__init__.py  | 1 -
 tests/test_cli.py          | 1 -
 tests/test_cli_nonlocal.py | 1 -
 tests/test_fixture.py      | 1 -
 5 files changed, 5 deletions(-)

diff --git a/conftest.py b/conftest.py
index cccab68..1008c06 100644
--- a/conftest.py
+++ b/conftest.py
@@ -29,7 +29,6 @@
 
 """
 
-
 import os.path as osp
 import platform
 import re
diff --git a/src/sphobjinv/__init__.py b/src/sphobjinv/__init__.py
index 325f1ba..e78e53b 100644
--- a/src/sphobjinv/__init__.py
+++ b/src/sphobjinv/__init__.py
@@ -29,7 +29,6 @@
 
 """
 
-
 from sphobjinv.data import DataFields, DataObjBytes, DataObjStr
 from sphobjinv.enum import HeaderFields, SourceTypes
 from sphobjinv.error import SphobjinvError, VersionError
diff --git a/tests/test_cli.py b/tests/test_cli.py
index 71f99b8..5728fb0 100644
--- a/tests/test_cli.py
+++ b/tests/test_cli.py
@@ -29,7 +29,6 @@
 
 """
 
-
 import json
 import re
 import shlex
diff --git a/tests/test_cli_nonlocal.py b/tests/test_cli_nonlocal.py
index c2d8ea3..dd31831 100644
--- a/tests/test_cli_nonlocal.py
+++ b/tests/test_cli_nonlocal.py
@@ -29,7 +29,6 @@
 
 """
 
-
 import json
 import re
 
diff --git a/tests/test_fixture.py b/tests/test_fixture.py
index 0a19aab..9dfdd84 100644
--- a/tests/test_fixture.py
+++ b/tests/test_fixture.py
@@ -29,7 +29,6 @@
 
 """
 
-
 import pytest
 
 pytestmark = pytest.mark.fixture

From fba8cfd2f6d3119cc36f427b9ef91e087bf52c2a Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:15:37 -0500
Subject: [PATCH 26/35] Make a first-pass update to CONTRIBUTING.md

Might be more to do, need to review this
---
 CONTRIBUTING.md | 88 +++++++++++++++++++++++--------------------------
 1 file changed, 42 insertions(+), 46 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 01f1f54..f415939 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,6 +18,7 @@ Table of Contents <!-- omit in toc -->
 - [Project Setup](#project-setup)
 - [Working with git](#working-with-git)
 - [Tests](#tests)
+- [Code Autoformatting](#code-autoformatting)
 - [Linting](#linting)
 - [Type Hints](#type-hints)
 - [Documentation](#documentation)
@@ -33,54 +34,40 @@ Table of Contents <!-- omit in toc -->
 
 Start by forking the repo and cloning locally:
 
-```
+```bash
 $ git clone https://github.com/{you}/sphobjinv
 ```
 
 Then, create a virtual environment for the project, in whatever location you
-prefer. Any Python interpreter 3.8+ *should* work fine.
+prefer. Any Python interpreter 3.9+ *should* work fine.
 
 I prefer to use `virtualenv` and create in `./env`:
 
-```
-$ python3.11 -m virtualenv env --prompt="sphobjinv"
+```bash
+$ python3.12 -m virtualenv env --prompt="sphobjinv"
 ```
 
 Activate the environment:
 
-```
-=== Linux/Mac
+```bash
+# Linux/Mac
 $ source env/bin/activate
 
-=== Windows
+# Windows
 > env\scripts\activate
 ```
 
 The next step is to upgrade/install the development requirements:
 
-```
+```bash
 (sphobjinv) $ python -m pip install -U pip setuptools wheel
 (sphobjinv) $ pip install -r requirements-dev.txt
 ```
 
-Then, install the [`pre-commit`](https://pre-commit.com/) hooks:
-
-```
-(sphobjinv) $ pre-commit install
-```
-
-One of the `pre-commit` hooks installed on the project is the hook from
-[`black`](https://black.readthedocs.io/en/stable/). If you want to run `black`
-independently from `pre-commit`, you'll need to install it separately:
-
-```
-(sphobjinv) $ pip install black
-```
-
 Finally, you'll need to build the Sphinx docs locally, as some of the tests
 interact with them:
 
-```
+```bash
 (sphobjinv) $ cd doc
 (sphobjinv) doc $ make html
 ```
@@ -93,7 +80,7 @@ couple of key functionalities you'll need.
 
 First, always hack on a bugfix or feature in a new branch:
 
-```
+```bash
 $ git checkout -b description-of-change
 ```
 
@@ -103,13 +90,13 @@ receives further commits.
 To bring your fork's `main` up to date, you first need to add the main repo as a
 new git remote (one-time task):
 
-```
+```bash
 $ git remote add upstream https://github.com/bskinn/sphobjinv
 ```
 
 Then, any time you need to refresh the fork's `main`:
 
-```
+```bash
 $ git fetch --all
 $ git checkout main
 $ git merge upstream/main   # (should merge without incident)
@@ -123,7 +110,7 @@ $ git push                  # (should push to your fork without incident)
 for most of its automated tests. From a properly configured virtual environment,
 a simple no-arguments invocation is all that is required:
 
-```
+```bash
 $ pytest
 ```
 
@@ -131,7 +118,7 @@ The test suite defaults to running only local tests, those that do **NOT**
 require network access. To include the nonlocal tests, run with the `--nonloc`
 flag:
 
-```
+```bash
 $ pytest --nonloc
 ```
 
@@ -150,18 +137,27 @@ to ignore coverage on certain line(s) of code. Please start a discussion in the
 issue or PR comments before adding such a pragma.
 
 Note that while [`tox`](https://tox.wiki/en/latest/) *is* configured for the
-project, it is **not** set up to be an everyday test runner. Instead, it's used
-to execute an extensive matrix of test environments checking for the
-compatibility of different Python and dependency versions. You can run it if you
-want, but you'll need working versions of all of Python 3.8 through 3.12
-installed and on `PATH` as `python3.8`, `python3.9`, etc. The nonlocal test
-suite is run for each `tox` environment, so it's best to use at most two
-parallel sub-processes to avoid oversaturating your network bandwidth; e.g.:
-
-```
+project, it is **not** set up to be an everyday test runner. Instead, its
+purpose for testing is to execute an extensive matrix of test environments
+checking for the compatibility of different Python and dependency versions. You
+can run it if you want, but you'll need working versions of all of Python 3.9
+through 3.13 installed and on `PATH` as `python3.9`, `python3.10`, etc. The
+nonlocal test suite is run for each `tox` environment, so it's best to use at
+most two parallel sub-processes to avoid oversaturating your network bandwidth;
+e.g.:
+
+```bash
 $ tox -rp2
 ```
 
+## Code Autoformatting
+
+The project is set up with a `tox` environment to blacken the codebase; run with:
+
+```bash
+$ tox -e black
+```
+
 
 ## Linting
 
@@ -169,7 +165,7 @@ The project uses a number of lints, which are checked using
 [`flake8`](https://flake8.pycqa.org/en/latest/) in CI. To run the lints locally,
 it's easiest to use `tox`:
 
-```
+```bash
 $ tox -e flake8
 ```
 
@@ -185,7 +181,7 @@ functions, classes and methods have docstrings using the
 [`interrogate`](https://pypi.org/project/interrogate/) package. There's a `tox`
 environment for running this check, also:
 
-```
+```bash
 $ tox -e interrogate
 ```
 
@@ -220,11 +216,11 @@ build the docs properly, as Sphinx does its best to detect which files were
 changed and rebuild only the minimum portion of the documentation necessary. If
 the docs seem not to be rendering correctly, try a clean build:
 
-```
-=== Linux/Mac
+```bash
+# Linux/Mac
 doc $ make clean html
 
-=== Windows
+# Windows
 doc> make -Ea
 ```
 
@@ -233,11 +229,11 @@ It's also a good idea to build the complete docs every once in a while with its
 in order to detect any broken cross-references, as these will fail the
 [Azure CI pipeline](#continuous-integration):
 
-```
-=== Linux/Mac
+```bash
+# Linux/Mac
 doc $ O=-n make clean html
 
-=== Windows
+# Windows
 doc> make html -Ean
 ```
 
@@ -250,7 +246,7 @@ with `make linkcheck`.
 Both Github Actions and Azure Pipelines are set up for the project, and should
 run on any forks of the repository.
 
-Github Actions runs the test suite on Linux for Python 3.8 through 3.12, as well
+Github Actions runs the test suite on Linux for Python 3.9 through 3.13, as well
 as the `flake8` lints and the Sphinx doctests and link-validity testing, and is
 configured to run on all commits. The workflow can be skipped per-commit by
 including `[skip ci]` in the commit message.

From 1d85698df628e962d5758a128f16774a7a0c5eb6 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:16:11 -0500
Subject: [PATCH 27/35] Add 'black' env to tox

---
 tox.ini | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/tox.ini b/tox.ini
index 265fe53..471fe6a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -91,6 +91,12 @@ basepython=
     py310: python3.10
     py39: python3.9
 
+[testenv:black]
+skip_install=True
+deps=black
+commands=
+    black {posargs} .
+
 [testenv:flake8]
 skip_install=True
 deps=-rrequirements-flake8.txt

From d83931b750e7b48478729c7442d6ff4d52885fd6 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:16:22 -0500
Subject: [PATCH 28/35] Update Pepy badge link target

URL format changed.
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f90a22a..eec470f 100644
--- a/README.md
+++ b/README.md
@@ -201,7 +201,7 @@ under a [Creative Commons Attribution 4.0 International License][cc-by 4.0]
 [mit license]: https://opensource.org/licenses/MIT
 [numpy linspace]: https://numpy.org/doc/1.26/reference/generated/numpy.linspace.html
 [pepy badge]: https://pepy.tech/badge/sphobjinv/month
-[pepy link target]: https://pepy.tech/project/sphobjinv?versions=2.0.1&versions=2.1&versions=2.2.2&versions=2.3&versions=2.3.1
+[pepy link target]: https://pepy.tech/projects/sphobjinv?timeRange=threeMonths&category=version&includeCIDownloads=true&granularity=daily&viewType=chart&versions=2.0.*%2C2.1.*%2C2.2.*%2C2.3.*
 [pypi badge]: https://img.shields.io/pypi/v/sphobjinv.svg?logo=pypi]
 [pypi link target]: https://pypi.org/project/sphobjinv
 [python versions badge]: https://img.shields.io/pypi/pyversions/sphobjinv.svg?logo=python

From 5b0b3a4a0fd834e254f65dd3ab266ef3fba78d16 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:25:55 -0500
Subject: [PATCH 29/35] Update RtD to use Python 3.12

---
 .readthedocs.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index c8cb097..ab110bf 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -9,7 +9,7 @@ version: 2
 build:
   os: 'ubuntu-22.04'
   tools:
-    python: '3.10'
+    python: '3.12'
 
 # Python requirements
 python:

From 20cd1c4661f54ef169f747bbb123471f4fecfb8f Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:31:37 -0500
Subject: [PATCH 30/35] Bump version

---
 src/sphobjinv/version.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/sphobjinv/version.py b/src/sphobjinv/version.py
index d9a0888..0092afc 100644
--- a/src/sphobjinv/version.py
+++ b/src/sphobjinv/version.py
@@ -29,4 +29,4 @@
 
 """
 
-__version__ = "2.3.2.dev0"
+__version__ = "2.3.1.2"

From 6c215ca767c6df9b99f0cc4384c44d2df82d9f97 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Thu, 19 Dec 2024 00:31:52 -0500
Subject: [PATCH 31/35] Update CHANGELOG with bullets

Still need to add the version and the release date, when the time
comes.
---
 CHANGELOG.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c20092d..f165ba6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,45 @@ changes.
     template as intended.
     ([#298](https://github.com/bskinn/sphobjinv/issues/298))
 
+#### Internal
+
+  * Moved the Sphinx linkcheck job out of CI and into `tox`.
+    * The linkcheck is often flaky, and is a nuisance when it fails the CI.
+      Less-frequent link checking, at release-time, is sufficient.
+
+  * Renamed `.readthedocs.yml` to `.readthedocs.yaml` to comply with the new,
+    strict RtD requirement.
+
+  * Added read-only GitHub PAT to Azure Pipelines config to ensure Python 3.13
+    retrieval from GitHub doesn't hit a rate limit.
+
+  * Update flake8 version pin in `requirements-flake8.txt` to avoid a bug in
+    `pycodestyle`.
+
+  * Removed `.pre-commit-config.yaml`, to remove the expectation of using
+    pre-commit from the project.
+    * For a project with this low an external contribution volume, the costs
+      outweigh the benefits.
+
+  * Added a `black` environment to `tox` for convenience and better
+    encapsulation.
+
+  * Added `flake8-black` to `requirements-flake8.txt` so that blackened status
+    is checked as part of the linting, whether run manually or in CI.
+
+#### Administrative
+
+  * Added support for Python 3.13.
+
+  * Dropped support for Python 3.8 (EOL).
+
+  * Revised and updated `CONTRIBUTING.md`.
+
+  * Updated link target of Pepy badge to match the new URL format.
+
+  * Bumped Read the Docs Python version to 3.12.
+
+
 ### [2.3.1.1] - 2024-05-21
 
 #### Tests

From 30b52d44a8c2531d4aaf9f7ce5eebdf72e785754 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Fri, 20 Dec 2024 20:46:34 -0500
Subject: [PATCH 32/35] Switch AUTHORS.md from Twitter to Mastodon

---
 AUTHORS.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/AUTHORS.md b/AUTHORS.md
index b3dcc0e..c721a79 100644
--- a/AUTHORS.md
+++ b/AUTHORS.md
@@ -2,7 +2,8 @@ Credits
 =======
 
 `sphobjinv` is authored and maintained by Brian Skinn
-([Blog](https://bskinn.github.io)) ([Twitter](https://twitter.com/btskinn)).
+([Blog](https://bskinn.github.io))
+([Mastodon](https://fosstodon.org/@btskinn)).
 
 The idea for the project came about as I was starting to deepen my expertise
 with Sphinx, and found it hugely frustrating to debug cross-references to

From 19a1633da1cbb46245917cb6b33de17f86f7a70c Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Sun, 22 Dec 2024 10:33:35 -0500
Subject: [PATCH 33/35] Revise CONTRIBUTING.md

---
 CONTRIBUTING.md | 39 ++++++++++++++++++++++-----------------
 1 file changed, 22 insertions(+), 17 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f415939..28e29d5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,7 +32,7 @@ Table of Contents <!-- omit in toc -->
 
 ## Project Setup
 
-Start by forking the repo and cloning locally:
+Start by forking the repo on GitHub and cloning locally:
 
 ```bash
 $ git clone https://github.com/{you}/sphobjinv
@@ -88,7 +88,7 @@ This makes it a lot simpler to get your repo fork up to date after `main`
 receives further commits.
 
 To bring your fork's `main` up to date, you first need to add the main repo as a
-new git remote (one-time task):
+new git remote (one-time task per clone):
 
 ```bash
 $ git remote add upstream https://github.com/bskinn/sphobjinv
@@ -189,22 +189,23 @@ $ tox -e interrogate
 ## Type Hints
 
 I'd like to [roll out typing](https://github.com/bskinn/sphobjinv/issues/132) on
-the project at some point in the near future, and add
-[`mypy`](https://github.com/python/mypy) checking to CI. (This would be a great
-PR to put together, for anyone interested....) For now, types on contributed
-code are welcomed, but optional. Once the codebase is typed, though, they will
-be a required part of any PR touching code.
+the project at some point in the future, and add
+[`mypy`](https://github.com/python/mypy) checking to CI. A top-to-bottom effort
+to add types doesn't make sense at the moment, though, given open issues like
+[#118] and [#290]. So, for now, types on contributed code are welcomed, but optional.
+Once the codebase is typed, though, they will be a required part of any PR
+touching code.
 
 
 ## Documentation
 
-All of the project documentation (except the README) is generated via
-[Sphinx](https://github.com/sphinx-doc/sphinx), and should be updated for (at
-minimum) any behavior changes in the codebase. API changes should be documented
-in the relevant docstring(s), and possibly in the prose portions of the
-documentation as well. Please use the modified
+All of the project documentation except the README is generated via
+[Sphinx](https://github.com/sphinx-doc/sphinx). API changes must be documented
+in the relevant docstring(s), and possibly also in the prose portions of the
+documentation. Please use the modified
 [NumPy-style](https://numpydoc.readthedocs.io/en/latest/format.html) formatting
-for docstrings that is already in use in the project.
+for docstrings that is already in use in the project. Other changes may also
+warrant documentation changes.
 
 A large number of reStructuredText substitutions are defined in the `rst_epilog`
 setting within `conf.py`, to make the documentation source more readable. Feel
@@ -224,7 +225,7 @@ doc $ make clean html
 doc> make -Ea
 ```
 
-It's also a good idea to build the complete docs every once in a while with its
+It's also a good idea to build the complete docs every once in a while with the
 ['nitpicky' option](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky),
 in order to detect any broken cross-references, as these will fail the
 [Azure CI pipeline](#continuous-integration):
@@ -247,14 +248,14 @@ Both Github Actions and Azure Pipelines are set up for the project, and should
 run on any forks of the repository.
 
 Github Actions runs the test suite on Linux for Python 3.9 through 3.13, as well
-as the `flake8` lints and the Sphinx doctests and link-validity testing, and is
-configured to run on all commits. The workflow can be skipped per-commit by
+as the `flake8` lints and the Sphinx doctests. By default, the Github Actions
+will run on all commits, but the workflows can be skipped per-commit by
 including `[skip ci]` in the commit message.
 
 The Azure Pipelines CI runs an extensive matrix of cross-platform and
 cross-Python-version tests, as well as numerous other checks. Due to its length,
 it is configured to run only on release branches and PRs to `main` or `stable`.
-Azure Pipelines now [also obeys `[skip ci]`
+The Azure Pipelines workflows now [also obey `[skip ci]`
 directives](https://learn.microsoft.com/en-us/azure/devops/pipelines/repos/azure-repos-git?view=azure-devops&tabs=yaml#skipping-ci-for-individual-pushes).
 
 
@@ -287,3 +288,7 @@ issue/PR you want to create, though, then don't use them.
 
 All code and documentation contributions will respectively take on the MIT
 License and CC BY 4.0 license of the project at large.
+
+
+[#118]: https://github.com/bskinn/sphobjinv/issues/118
+[#290]: https://github.com/bskinn/sphobjinv/issues/290

From 51112cf710a9d42577eeb685d087642f1182b5cd Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Sun, 22 Dec 2024 16:44:12 -0500
Subject: [PATCH 34/35] Rearrange reporting of doc rendering fix in CHANGELOG

It's not a project-code fix, so it shouldn't go into 'Fixed'.
---
 CHANGELOG.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f165ba6..6b4b3cb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,20 +10,20 @@ changes.
 
 ### Unreleased
 
-#### Fixed
+#### Internal
 
-  * The `super` keyword used in a statement in the HTML footer
+  * **DOC RENDERING FIX**: The `super` keyword used in a statement in the HTML footer
     template was missing parentheses to perform a method call; this
     caused the template rendering to emit a Python string describing
     the parent template object, instead of rendering the parent
     template as intended.
     ([#298](https://github.com/bskinn/sphobjinv/issues/298))
 
-#### Internal
-
   * Moved the Sphinx linkcheck job out of CI and into `tox`.
-    * The linkcheck is often flaky, and is a nuisance when it fails the CI.
-      Less-frequent link checking, at release-time, is sufficient.
+    * The linkcheck is often flaky, and is a nuisance when it fails the CI. For
+      uncertain reasons, the flakiness has increased noticeably in recent
+      months. Less-frequent link checking, at release-time, is sufficient; so,
+      we move the check out of CI.
 
   * Renamed `.readthedocs.yml` to `.readthedocs.yaml` to comply with the new,
     strict RtD requirement.

From 7245e8fa7540e965e2116a048bc7a40252148d82 Mon Sep 17 00:00:00 2001
From: Brian Skinn <brian.skinn@gmail.com>
Date: Sun, 22 Dec 2024 16:44:46 -0500
Subject: [PATCH 35/35] Add CHANGELOG version and date for release

---
 CHANGELOG.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6b4b3cb..b785859 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,7 +8,7 @@ and this project follows an extension of
 fourth number represents an administrative maintenance release with no code
 changes.
 
-### Unreleased
+### [2.3.1.2] - 2024-12-22
 
 #### Internal