Merged
Conversation
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
notatallshaw
approved these changes
Mar 26, 2026
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Contributor
Author
|
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
commented
Mar 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As far as I can tell, we are not using sphinx-toolbox at all; the only extension enabled was autotypeddict, but we don't useautotypeddictanywhere, and it doesn't become part of automoduleas 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.