Skip to content

Commit

Permalink
Merge pull request #303 from bskinn/release-2.3.1.2
Browse files Browse the repository at this point in the history
Release 2.3.1.2
  • Loading branch information
bskinn authored Dec 22, 2024
2 parents 219530d + 7245e8f commit b34d0fc
Show file tree
Hide file tree
Showing 20 changed files with 171 additions and 149 deletions.
11 changes: 3 additions & 8 deletions .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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]')"

Expand All @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -63,7 +58,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:
Expand Down
18 changes: 0 additions & 18 deletions .pre-commit-config.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion .readthedocs.yml → .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: 'ubuntu-22.04'
tools:
python: '3.10'
python: '3.12'

# Python requirements
python:
Expand Down
3 changes: 2 additions & 1 deletion AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
50 changes: 50 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,56 @@ and this project follows an extension of
fourth number represents an administrative maintenance release with no code
changes.

### [2.3.1.2] - 2024-12-22

#### Internal

* **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))

* 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. 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.

* 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
Expand Down
Loading

0 comments on commit b34d0fc

Please sign in to comment.