Add CI check that generated documentation is up to date#10986
Open
Pierre-Sassoulas wants to merge 2 commits intopylint-dev:mainfrom
Open
Add CI check that generated documentation is up to date#10986Pierre-Sassoulas wants to merge 2 commits intopylint-dev:mainfrom
Pierre-Sassoulas wants to merge 2 commits intopylint-dev:mainfrom
Conversation
Pierre-Sassoulas
added
Maintenance
The Sphinx extensions in doc/exts/ regenerate tracked .rst files on every build, but a clean Sphinx build was not enough to flag drift in the committed copies. Run 'git diff --exit-code' after 'tox -e docs' so PRs that change checker messages or options must include the regenerated docs.
Pierre-Sassoulas
force-pushed
the
doc-stay-up-to-date
branch
from
5f6a0d0 to
bc6ad52
Compare
Member
Author
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #10986 +/- ##
=======================================
Coverage 96.19% 96.19%
=======================================
Files 178 178
Lines 19683 19683
=======================================
Hits 18934 18934
Misses 749 749 🚀 New features to boost your workflow:
|
Contributor
|
🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉 This comment was generated for commit c86eabf |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type of Changes
Description
The Sphinx extensions in doc/exts/ regenerate tracked .rst files on
every build, but a clean Sphinx build was not enough to flag drift in
the committed copies. Run 'git diff --exit-code' after 'tox -e docs' so
PRs that change checker messages or options must include the
regenerated docs.