FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix Sphinx warning in gc.rst and refactor docs clean list by hugovk · Pull Request #103116 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Fix Sphinx warning in gc.rst and refactor docs clean list #103116

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.

Sign up for GitHub

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
hugovk merged 7 commits into from
Mar 30, 2023
Conversation 30 Commits 7 Checks 0 Files changed
Merged

gh-101100: Fix Sphinx warning in gc.rst and refactor docs clean list #103116

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
198bd9d
gh-101100: Touch files that must pass Sphinx nit-picky mode
hugovk Mar 29, 2023
f7b3ccd
gh-101100: Fix reference to __del__ in gc.rst
hugovk Mar 29, 2023
a433b15
Simplify print
hugovk Mar 29, 2023
a252fb6
Move cleaned files to text file
hugovk Mar 29, 2023
e1dd7af
Add comments to input file and strip input
hugovk Mar 30, 2023
e60409e
Keep them sorted
hugovk Mar 30, 2023
a802d55
Apply suggestions from code review
hugovk Mar 30, 2023
File filter

Filter by extension

Filter by extension .py  (1) .yml  (1) All 2 file types selected
Only manifest files
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
Next Next commit
gh-101100: Touch files that must pass Sphinx nit-picky mode
  • Loading branch information
hugovk committed Mar 29, 2023
commit 198bd9db81c88d0e9aba0107c124c7d8e4ce4813
3 changes: 1 addition & 2 deletions .github/workflows/doc.yml
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,7 @@ jobs:
- name: 'Build known-good files in nit-picky mode'
run: |
# Mark files that must pass nit-picky
touch Doc/whatsnew/3.12.rst
touch Doc/library/sqlite3.rst
python Doc/tools/touch-clean-files.py
# 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

Expand Down
17 changes: 17 additions & 0 deletions Doc/tools/touch-clean-files.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#!/usr/bin/env python3
"""
Touch files that must pass Sphinx nit-picky mode
so they are rebuilt and we can catch regressions.
"""

from pathlib import Path

CLEAN = [
"Doc/library/gc.rst",
"Doc/library/sqlite3.rst",
"Doc/whatsnew/3.12.rst",
]
Comment thread
hugovk marked this conversation as resolved.
Resolved
print("Touching:")
for filename in CLEAN:
print(f"{filename}")
Comment thread
hugovk marked this conversation as resolved.
Resolved
Path(filename).touch()
Back | FazBrowse Home | New Git URL