Skip to content

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
merged 7 commits into from
Mar 30, 2023
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
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
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/doc.yml
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion Doc/library/gc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ values but should not rebind them):
are printed.

.. versionchanged:: 3.4
Following :pep:`442`, objects with a :meth:`__del__` method don't end
Following :pep:`442`, objects with a :meth:`~object.__del__` method don't end
up in :attr:`gc.garbage` anymore.

.. data:: callbacks
Expand Down
17 changes: 17 additions & 0 deletions Doc/tools/touch-clean-files.py
View file
Open in desktop
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",
]
print("Touching:")
for filename in CLEAN:
print(f"{filename}")
Path(filename).touch()