-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
gh-101100: Test docs in nit-picky mode #102513
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
ed0540b
GHA, Docs: Add PR annotations for failed Sphinx references
encukou 4e2ef71
GHA, Docs: Ensure some files always pass Sphinx nitpicks
hugovk d1ce7f9
Fix Sphinx warnings in 'What's New In Python 3.12'
hugovk 238dfc2
Use Ana06/get-changed-files to fix 'The head commit for this pull_req…
hugovk b97f25b
Apply suggestions from code review
hugovk 1465769
Document PyObject_ClearWeakRefs
hugovk 460d83f
Document gzip's filename
hugovk bd7dbd6
Consistent quotes
hugovk 15b6b1b
Merge remote-tracking branch 'upstream/main' into docs-nit-picky
hugovk dded66d
Fix reference warnings to removed opcodes
hugovk e14191b
Fix PyErr_DisplayException reference, skip linking to undocumented an…
hugovk 255a67f
Document asyncio.iscoroutine
hugovk 742e29a
Merge branch 'main' into docs-nit-picky
hugovk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Apply suggestions from code review
Co-authored-by: C.A.M. Gerlach <[email protected]>
- Loading branch information
commit b97f25be3a5f47b518c8d2ff7c882da5a2036f22
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,20 +57,21 @@ jobs: | |
| - name: Get list of changed files | ||
| id: changed_files | ||
| uses: Ana06/[email protected] | ||
| - name: 'Build changed files with nitpicks' | ||
| - name: 'Build changed files in nit-picky mode' | ||
| continue-on-error: true | ||
| run: | | ||
| # Mark files the pull request modified | ||
| touch ${{ steps.changed_files.outputs.added_modified }} | ||
| # Build docs with the '-n' (nit-picky) option, convert warnings | ||
| # Build docs with the '-n' (nit-picky) option; convert warnings to annotations | ||
| make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n --keep-going" html 2>&1 | | ||
| python Doc/tools/warnings-to-gh-actions.py | ||
|
|
||
| # Ensure some files always pass Sphinx nitpicks (missing references) | ||
| - name: 'Build others with nitpicks' | ||
| # Ensure some files always pass Sphinx nit-picky mode (no missing references) | ||
| - name: 'Build known-good files in nit-picky mode' | ||
hugovk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| run: | | ||
| # Mark files that must pass nit-picky | ||
| touch Doc/whatsnew/3.12.rst | ||
hugovk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| touch Doc/library/sqlite3.rst | ||
| # Build docs with the '-n' (nit-picky) option, convert warnings to errors (-W) | ||
| make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going" html 2>&1 | ||
|
|
||
|
|
||
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.