Add support for newer Sphinx versions, fix up some related warnings.

Review Request #14476 — Created June 25, 2025 and submitted — Latest diff uploaded

Information

beanbag-docutils
master

Reviewers

This change adds support for Sphinx 8.0 to our pyproject.toml and
tox.ini files, and fleshes out the tox configuration a bit for wider
version compatibility checking.

This also fixes a few warnings that were popping up when using
collect_files against Sphinx 7.4:

  • The default for collect_file_patterns was set to a dict, but it was
    used as a list.
  • The "rebuild" parameter for app.add_config_value() has changed from a
    simple bool to a string defining when to rebuild. The string version
    is supported in all our supported versions.
  • The comparison against Sphinx's src_dir warned that we should use
    pathlib.Path or os.fspath instead of a string.

Ran tests via tox.

Diff Revision 1

This is not the most recent revision of the diff. The latest diff is revision 2. See what's changed.

orig
1
2

Commits

First Last Summary ID Author
Add support for newer Sphinx versions, fix up some related warnings.
This change adds support for Sphinx 8.0 to our pyproject.toml and tox.ini files, and fleshes out the tox configuration a bit for wider version compatibility checking. This also fixes a few warnings that were popping up when using collect_files against Sphinx 7.4: - The default for `collect_file_patterns` was set to a dict, but it was used as a list. - The "rebuild" parameter for app.add_config_value() has changed from a simple bool to a string defining when to rebuild. The string version is supported in all our supported versions. - The comparison against Sphinx's `src_dir` warned that we should use `pathlib.Path` or `os.fspath` instead of a string. Testing Done: Ran tests via tox.
8fd5eef901fe4f92a5256c2f577859b701f7846d David Trowbridge
.gitignore
py.typed
pyproject.toml
tox.ini
beanbag_docutils/sphinx/ext/collect_files.py
Loading...