Skip to content
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

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

Merged
merged 7 commits into from
Mar 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
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
10 changes: 10 additions & 0 deletions Doc/tools/clean-files.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# These files must pass Sphinx nit-picky mode, as tested on the CI
# via touch-clean-files.py in doc.yml.
# Add blank lines between files and keep them sorted lexicographically
# to help avoid merge conflicts.

Doc/library/gc.rst

Doc/library/sqlite3.rst

Doc/whatsnew/3.12.rst
hugovk marked this conversation as resolved.
Show resolved Hide resolved
20 changes: 20 additions & 0 deletions Doc/tools/touch-clean-files.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/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

# Input file has blank line between entries to reduce merge conflicts
with Path("Doc/tools/clean-files.txt").open() as clean_files:
CLEAN = [
Path(filename.strip())
for filename in clean_files
if filename.strip() and not filename.startswith("#")
]

print("Touching:")
for filename in CLEAN:
print(filename)
filename.touch()