-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Tighten up docs CI checks #5913
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
base: master
Are you sure you want to change the base?
Conversation
1cadaee
to
3110439
Compare
198f1e0
to
02a0ab1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good generally! I guess you did not do all the changes manually. Could you add a poe command for the auto docs formatting? Also a reference/sentence in the contribution guide would be highly appreciated!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds sphinx-lint
to the documentation CI checks to catch issues like line length violations, improving documentation quality and consistency.
- Adds
sphinx-lint
dependency to the documentation build pipeline - Adds
docstrfmt
dependency for formatting documentation - Updates test fixtures to reflect proper documentation formatting conventions
Reviewed Changes
Copilot reviewed 107 out of 111 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
test/test_release.py | Updates test fixtures to use proper RST formatting with consistent bullet points, code blocks, and indentation |
pyproject.toml | Adds sphinx-lint and docstrfmt dependencies with new poe tasks for documentation linting and formatting |
extra/release.py | Temporarily adds debugging code and modifies changelog processing logic |
docs/team.rst | Converts documentation from using asterisks to hyphens for bullet points and proper heading underlines |
docs/reference/query.rst | Fixes code block formatting by separating introductory text from code examples with proper spacing |
docs/reference/pathformat.rst | Improves line length compliance and consistent formatting throughout the document |
docs/reference/config.rst | Extensive reformatting for better line length compliance and consistent bullet point usage |
docs/reference/cli.rst | Converts bullet points to hyphens and improves line wrapping for better readability |
docs/plugins/*.rst | Multiple plugin documentation files updated for consistent formatting, proper line lengths, and standardized bullet point usage |
b522980
to
cca2694
Compare
Funnily, I initially only addressed the linting issues (lines being too long) selectively. On the other hand, I guess, we want to have consistent formatting across all docs. Thus now I have reformatted everything using |
0e83307
to
b3b36bf
Compare
Would it be possible to group all automated changes into a single commit and list its hash in the .git-blame-ignore-revs file? |
That's exactly what I will do once you confirm that we're good to go! |
b3b36bf
to
bf44699
Compare
I guess we should be good to go. All seems reasonable to me 👍 |
Maybe one more thing could you add the command to the precommit hook too? 🙏 |
bf44699
to
d6b7db2
Compare
d6b7db2
to
0c77f4f
Compare
0c77f4f
to
cff56fb
Compare
Cool, done it. Squashed docs adjustments to two commits and added them to blame ignore revs. |
This PR adds
sphinx-lint
check for docs which catches issues like line length.