Summary

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

Review Request #14476 — Created June 25, 2025 and submitted July 7, 2025, 3:29 p.m.

Information

Owner

david

Repository

beanbag-docutils

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

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.

Commits

Summary	ID
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.	1f7a7f267b6f9d697c96d33de54bfadaa59f516d

Summary

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.

1f7a7f267b6f9d697c96d33de54bfadaa59f516d

Issues

Description	From	Last Updated
I was curious about the rename. I guess that's your linter upset about an unused parameter? I don't think we …	chipx86	June 26, 2025, 9:55 a.m.
I don't think this is safe. Sphinx 5 uses strings for srcdir, and a comparison between a Path(...) and a …	chipx86	June 26, 2025, 9:55 a.m.

flake8 passed.

JSHint passed.

beanbag_docutils/sphinx/ext/collect_files.py (Diff revision 1)

The issue has been resolved. Show all issues

I was curious about the rename. I guess that's your linter upset about an unused parameter? I don't think we should get in the habit of altering function signatures for that requirement, as that's going to pose problems depending on how the function is called. That should just be turned off on any linter for arguments.

beanbag_docutils/sphinx/ext/collect_files.py (Diff revision 1)

The issue has been resolved. Show all issues

I don't think this is safe. Sphinx 5 uses strings for srcdir, and a comparison between a Path(...) and a string fails.

Probably better to normalize srcdir to a string before entering this loop.

Commits:

	Summary	ID
	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
	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.	1f7a7f267b6f9d697c96d33de54bfadaa59f516d

Diff:

Revision 2 (+92 -24)

Show changes

	.gitignore
	py.typed
	pyproject.toml
	tox.ini
	beanbag_docutils/sphinx/ext/collect_files.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (f16066c)