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: Use list of 'dirty' docs, with warnings, instead of a clean list #103191

Merged
merged 4 commits into from
Apr 3, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Apr 2, 2023

As suggested in #103116 (comment), keep a "dirty" list of docs with warnings, instead of a "clean" list of docs with warnings.

This means we have a checklist of files to work on to clean, and any new files added to the Doc/ directory would by default be tested with nitpicks enabled.

The functionality is essentially the same, the clean docs are touched and rebuilt.

In calculating the clean files:

  1. start with all *.rst files from Doc/
  2. remove any from Doc/venv/
  3. remove files listed in Doc/tools/dirty-files.txt
  4. remove Doc/includes/wasm-notavail.rst and Doc/whatsnew/changelog.rst, which would trigger dirty files to be rebuilt

Doc/tools/touch-clean-files.py Show resolved Hide resolved
Doc/tools/touch-clean-files.py Outdated Show resolved Hide resolved
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, thanks, just a couple comments.

Doc/tools/touch-clean-files.py Outdated Show resolved Hide resolved
Doc/tools/dirty-files.txt Outdated Show resolved Hide resolved
Doc/tools/.nitignore Outdated Show resolved Hide resolved
hugovk and others added 2 commits April 3, 2023 18:05
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@hugovk hugovk merged commit 24facd6 into python:main Apr 3, 2023
@hugovk hugovk deleted the docs-dirty-list branch April 3, 2023 18:59
gaogaotiantian pushed a commit to gaogaotiantian/cpython that referenced this pull request Apr 8, 2023
…a clean list (python#103191)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
warsaw pushed a commit to warsaw/cpython that referenced this pull request Apr 11, 2023
…a clean list (python#103191)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants