Skip to content

gh-101100: Use list of 'dirty' docs, with warnings, instead of a clean list#103191

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

Jump to bottom
Merged
hugovk merged 4 commits into from
Apr 3, 2023
Merged

gh-101100: Use list of 'dirty' docs, with warnings, instead of a clean list #103191

hugovk merged 4 commits into from
Apr 3, 2023

Conversation

@hugovk
Copy link
Member

@hugovkhugovk commented Apr 2, 2023•
edited by bedevere-bot
Loading

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

@bedevere-botbedevere-bot mentioned this pull request Apr 2, 2023
Open
@hugovkhugovk added skip news docs Documentation in the Doc dir labels Apr 2, 2023
@hugovkhugovk mentioned this pull request Apr 2, 2023
Merged
AlexWaygood
AlexWaygood reviewed Apr 2, 2023
View reviewed changes
CAM-Gerlach
CAM-Gerlach reviewed Apr 2, 2023
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-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.

AlexWaygood
AlexWaygood reviewed Apr 2, 2023
View reviewed changes
arhadthedev
arhadthedev reviewed Apr 2, 2023
View reviewed changes
hugovkand others added 2 commits April 3, 2023 18:05
@hugovk@AlexWaygood
Ensure script is run from repo root
8d2f939
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk
Remove empty lines
da8d41b
AlexWaygood
AlexWaygood approved these changes Apr 3, 2023
View reviewed changes
Copy link
Member

@AlexWaygoodAlexWaygood 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!

@hugovkhugovk merged commit 24facd6 into python:mainApr 3, 2023
@hugovkhugovk 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
@hugovk@AlexWaygood@gaogaotiantian
pythongh-101100: Use list of 'dirty' docs, with warnings, instead of …
86a7818
…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
@hugovk@AlexWaygood@warsaw
pythongh-101100: Use list of 'dirty' docs, with warnings, instead of …
f913a0f
…a clean list (python#103191) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arhadthedevarhadthedevarhadthedev left review comments

@CAM-GerlachCAM-GerlachCAM-Gerlach left review comments

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@hugovk@arhadthedev@CAM-Gerlach@AlexWaygood@bedevere-bot