Skip to content

Fix rstcheck warnings #474

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

Merged
merged 9 commits into from
Jul 28, 2025
Merged

Fix rstcheck warnings #474

merged 9 commits into from
Jul 28, 2025

Conversation

mmerklinger
Copy link
Collaborator

This PR fixes most of the warnings of the rstcheck CI pipeline job.

The left warnings are due to rstcheck being unable to handle .. include:: and explicit target link directives. Either we replace them with their actual content or declare them as to be ignored in the configuration.

This PR is based on #473.

@mmerklinger mmerklinger requested a review from daringer July 14, 2025 14:56
@mmerklinger mmerklinger self-assigned this Jul 14, 2025
Copy link

The successful documentation build was deployed for preview:

@mmerklinger mmerklinger force-pushed the fix-rstcheck-warnings branch from a9adbb2 to 0d39305 Compare July 15, 2025 13:47
Copy link

The successful documentation build was deployed for preview:

@mmerklinger mmerklinger force-pushed the fix-rstcheck-warnings branch from 0d39305 to 1da44e9 Compare July 21, 2025 19:43
Copy link

The successful documentation build was deployed for preview:

@mmerklinger mmerklinger marked this pull request as ready for review July 21, 2025 19:46
@daringer
Copy link
Contributor

@mmerklinger are you planning to include the include:: removal into this PR, or should we merge this and you do this separately ? I'd prefer the former I guess

@mmerklinger mmerklinger marked this pull request as draft July 22, 2025 14:17
@mmerklinger
Copy link
Collaborator Author

I will include it here. Turned the PR back to draft.

@mmerklinger mmerklinger force-pushed the fix-rstcheck-warnings branch from 1da44e9 to c1e7fc5 Compare July 25, 2025 11:51
Copy link

The successful documentation build was deployed for preview:

@mmerklinger mmerklinger marked this pull request as ready for review July 25, 2025 11:53
@mmerklinger mmerklinger force-pushed the fix-rstcheck-warnings branch from c1e7fc5 to dc6a57f Compare July 28, 2025 08:07
Copy link

The successful documentation build was deployed for preview:

@mmerklinger mmerklinger merged commit 238c83b into main Jul 28, 2025
3 checks passed
@mmerklinger mmerklinger deleted the fix-rstcheck-warnings branch July 28, 2025 09:05
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