Skip to content

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Tighten up docs CI checks #5913

wants to merge 9 commits into from

Conversation

snejus
Copy link
Member

@snejus snejus commented Aug 2, 2025

This PR adds sphinx-lint check for docs which catches issues like line length.

@snejus snejus requested review from Copilot, semohr and wisp3rwind and removed request for wisp3rwind and semohr August 2, 2025 18:13
@snejus snejus marked this pull request as draft August 2, 2025 18:13
Copilot

This comment was marked as outdated.

@snejus snejus force-pushed the add-sphinx-lint branch 5 times, most recently from 1cadaee to 3110439 Compare August 2, 2025 18:39
@snejus snejus marked this pull request as ready for review August 2, 2025 21:29
@snejus snejus force-pushed the add-sphinx-lint branch 2 times, most recently from 198f1e0 to 02a0ab1 Compare August 2, 2025 21:34
@snejus snejus requested a review from semohr August 7, 2025 10:23
Copy link
Contributor

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

@snejus snejus requested a review from Copilot August 8, 2025 16:17
Copy link
Contributor

@Copilot Copilot AI left a 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

@snejus snejus force-pushed the add-sphinx-lint branch 2 times, most recently from b522980 to cca2694 Compare August 8, 2025 17:11
@snejus
Copy link
Member Author

snejus commented Aug 8, 2025

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!

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 docstrfmt and added relevant poe commands for formatting and linting.

@snejus snejus force-pushed the add-sphinx-lint branch 5 times, most recently from 0e83307 to b3b36bf Compare August 8, 2025 21:43
@semohr
Copy link
Contributor

semohr commented Aug 9, 2025

Would it be possible to group all automated changes into a single commit and list its hash in the .git-blame-ignore-revs file?

@snejus
Copy link
Member Author

snejus commented Aug 10, 2025

That's exactly what I will do once you confirm that we're good to go!

@semohr
Copy link
Contributor

semohr commented Aug 10, 2025

That's exactly what I will do once you confirm that we're good to go!

I guess we should be good to go. All seems reasonable to me 👍

@semohr
Copy link
Contributor

semohr commented Aug 10, 2025

Maybe one more thing could you add the command to the precommit hook too? 🙏

@snejus
Copy link
Member Author

snejus commented Aug 10, 2025

Maybe one more thing could you add the command to the precommit hook too? 🙏

Cool, done it. Squashed docs adjustments to two commits and added them to blame ignore revs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants