Skip to content

Commit b34d0fc

Browse files
authored
Merge pull request #303 from bskinn/release-2.3.1.2
Release 2.3.1.2
2 parents 219530d + 7245e8f commit b34d0fc

20 files changed

+171
-149
lines changed

.github/workflows/ci_tests.yml

+3-8
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on: push
44

55
jobs:
66
all_checks:
7-
name: Run all tests, lints, etc. (Python 3.11)
7+
name: Run all tests, lints, etc. (Python 3.12)
88
runs-on: ubuntu-latest
99
if: "!contains(github.event.head_commit.message, '[skip ci]')"
1010

@@ -15,7 +15,7 @@ jobs:
1515
- name: Install Python
1616
uses: actions/setup-python@v5
1717
with:
18-
python-version: '3.11'
18+
python-version: '3.12'
1919
cache: 'pip'
2020
cache-dependency-path: |
2121
requirements-ci.txt
@@ -46,11 +46,6 @@ jobs:
4646
cd doc
4747
make doctest
4848
49-
- name: Run docs link check
50-
run: |
51-
cd doc
52-
make linkcheck
53-
5449
- name: Lint code
5550
run: tox -e flake8
5651

@@ -63,7 +58,7 @@ jobs:
6358
runs-on: ubuntu-latest
6459
strategy:
6560
matrix:
66-
python: ['3.8', '3.9', '3.10', '3.12']
61+
python: ['3.9', '3.10', '3.11', '3.13']
6762
if: "!contains(github.event.head_commit.message, '[skip ci]')"
6863

6964
steps:

.pre-commit-config.yaml

-18
This file was deleted.

.readthedocs.yml .readthedocs.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ version: 2
99
build:
1010
os: 'ubuntu-22.04'
1111
tools:
12-
python: '3.10'
12+
python: '3.12'
1313

1414
# Python requirements
1515
python:

AUTHORS.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ Credits
22
=======
33

44
`sphobjinv` is authored and maintained by Brian Skinn
5-
([Blog](https://bskinn.github.io)) ([Twitter](https://twitter.com/btskinn)).
5+
([Blog](https://bskinn.github.io))
6+
([Mastodon](https://fosstodon.org/@btskinn)).
67

78
The idea for the project came about as I was starting to deepen my expertise
89
with Sphinx, and found it hugely frustrating to debug cross-references to

CHANGELOG.md

+50
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,56 @@ and this project follows an extension of
88
fourth number represents an administrative maintenance release with no code
99
changes.
1010

11+
### [2.3.1.2] - 2024-12-22
12+
13+
#### Internal
14+
15+
* **DOC RENDERING FIX**: The `super` keyword used in a statement in the HTML footer
16+
template was missing parentheses to perform a method call; this
17+
caused the template rendering to emit a Python string describing
18+
the parent template object, instead of rendering the parent
19+
template as intended.
20+
([#298](https://github.com/bskinn/sphobjinv/issues/298))
21+
22+
* Moved the Sphinx linkcheck job out of CI and into `tox`.
23+
* The linkcheck is often flaky, and is a nuisance when it fails the CI. For
24+
uncertain reasons, the flakiness has increased noticeably in recent
25+
months. Less-frequent link checking, at release-time, is sufficient; so,
26+
we move the check out of CI.
27+
28+
* Renamed `.readthedocs.yml` to `.readthedocs.yaml` to comply with the new,
29+
strict RtD requirement.
30+
31+
* Added read-only GitHub PAT to Azure Pipelines config to ensure Python 3.13
32+
retrieval from GitHub doesn't hit a rate limit.
33+
34+
* Update flake8 version pin in `requirements-flake8.txt` to avoid a bug in
35+
`pycodestyle`.
36+
37+
* Removed `.pre-commit-config.yaml`, to remove the expectation of using
38+
pre-commit from the project.
39+
* For a project with this low an external contribution volume, the costs
40+
outweigh the benefits.
41+
42+
* Added a `black` environment to `tox` for convenience and better
43+
encapsulation.
44+
45+
* Added `flake8-black` to `requirements-flake8.txt` so that blackened status
46+
is checked as part of the linting, whether run manually or in CI.
47+
48+
#### Administrative
49+
50+
* Added support for Python 3.13.
51+
52+
* Dropped support for Python 3.8 (EOL).
53+
54+
* Revised and updated `CONTRIBUTING.md`.
55+
56+
* Updated link target of Pepy badge to match the new URL format.
57+
58+
* Bumped Read the Docs Python version to 3.12.
59+
60+
1161
### [2.3.1.1] - 2024-05-21
1262

1363
#### Tests

0 commit comments

Comments
 (0)