GH-145000: Add a tool to check removed HTML IDs#145001
Open
encukou wants to merge 5 commits intopython:mainfrom
Open
GH-145000: Add a tool to check removed HTML IDs#145001encukou wants to merge 5 commits intopython:mainfrom
encukou wants to merge 5 commits intopython:mainfrom
Conversation
encukou
requested review from
AA-Turner,
AlexWaygood and
hugovk
as code owners
Doc/tools/check-html-ids.py
Outdated
| def get_ids_from_file(path): | ||
| ids = set() | ||
| gatherer = IDGatherer(ids) | ||
| with path.open() as file: |
Member
Author
There was a problem hiding this comment.
UTF-8, as per PEP-686 :)
I'll set it explicitly to ease backporting. Thanks for the catch!
Doc/tools/check-html-ids.py
Outdated
Comment on lines
63
to
64
| ids = future.result() | ||
| ids_by_page[str(relative_path)] = future.result() |
Member
There was a problem hiding this comment.
future.result() is called twice.
|
|
||
| if args.command == 'check': | ||
| with gzip.open(args.baseline_file) as zfile: | ||
| baseline = json.load(zfile)['ids_by_page'] |
Member
There was a problem hiding this comment.
json.load() requires a text file, gzip.open() returns a binary file.
Doc/tools/check-html-ids.py
Outdated
| checked = json.load(zfile)['ids_by_page'] | ||
| excluded = set() | ||
| if args.exclude_file: | ||
| with open(args.exclude_file) as file: |
Doc/tools/check-html-ids.py
Outdated
| ids = gather_ids(args.htmldir, verbose_print=verbose_print) | ||
| if args.outfile is None: | ||
| args.outfile = args.htmldir / 'html-ids.json.gz' | ||
| with gzip.open(args.outfile, 'wt') as zfile: |
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
2 participants
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.
With this,
make -CDoc html-idswill create ahtml-ids.json.gzfile containing IDs in the built docs.📚 Documentation preview 📚: https://cpython-previews--145001.org.readthedocs.build/