Skip to content

chore: remove sphinx-toolbox#1135

Merged
henryiii merged 3 commits intopypa:mainfrom
henryiii:henryiii/chore/toolbox
Mar 26, 2026
Merged

chore: remove sphinx-toolbox#1135
henryiii merged 3 commits intopypa:mainfrom
henryiii:henryiii/chore/toolbox

Conversation

@henryiii
Copy link
Contributor

@henryiii henryiii commented Mar 26, 2026

As far as I can tell, we are not using sphinx-toolbox at all; the only extension enabled was autotypeddict, but we don't use autotypeddict anywhere, and it doesn't become part of automodule as far as I can tell. I don't see a difference on the type dicts in the docs. sphinx-toolbox doesn't support sphinx 9, so I think it's best to drop it for now. (I do like autotypeddict, as it shows required/optional keys, it's just that we aren't using it currently and I don't want to force sphinx<9. See https://packaging.pypa.io/en/stable/metadata.html#packaging.metadata.RawMetadata)

Also did a couple of other minor cleanups to config to reduce the diff in #795: made a few long TOML lists multiline and moved the docs job to 3.14.

Edit: It does work automatically if the keys are documented. However, it only adds a single Required/Optional header, and removes newlines (which we could just do in the source if we wanted to). I'm fixing the TypedDicts we have to show all keys, and then I think it's not needed.

Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
@henryiii
Copy link
Contributor Author

henryiii commented Mar 26, 2026

The new RawMetadata now shows the keys, so the new version is better than before. You can see the difference for one that was working at https://packaging.pypa.io/en/stable/markers.html#packaging.markers.Environment - it's a bit less compact, but I think it's fine to drop a dependency that limits the sphinx version.

(And those two are the only TypedDicts that are public)

@henryiii henryiii merged commit ce2ab9e into pypa:main Mar 26, 2026
56 checks passed
@henryiii henryiii deleted the henryiii/chore/toolbox branch March 26, 2026 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants