Skip to content

docs: enable nitpicking for xref validation #476

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
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: enable nitpicking for xref validation #476

wants to merge 4 commits into from

Conversation

jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented Aug 15, 2024 •
edited
Loading

This pull-request is a continuation of #467. It ensures that all cross-references in our documentation point to existing content.

Addresses:

  •  Stop using :py:attr: for enumeration items
  • Use fully qualified specifiers to ensure Sphinx handles all xrefs properly

@jorgepiloto jorgepiloto requested a review from a team as a code owner August 15, 2024 07:17
@jorgepiloto jorgepiloto added docs:api Related to API documentation tests:skip Skip tests runs in CI/CD labels Aug 15, 2024
jorgepiloto
jorgepiloto commented Aug 15, 2024
View reviewed changes
MaxJPRey
MaxJPRey previously approved these changes Aug 15, 2024
View reviewed changes
Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@jwinkle8 jwinkle8 added docs:examples Related to documentation examples and removed docs:examples Related to documentation examples labels Sep 9, 2024
@jorgepiloto jorgepiloto requested a review from a team as a code owner January 30, 2025 13:19
@jorgepiloto jorgepiloto changed the title doc: enable nitpicking for xref validation docs: enable nitpicking for xref validation Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MaxJPRey MaxJPRey MaxJPRey left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
docs:api Related to API documentation tests:skip Skip tests runs in CI/CD
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jorgepiloto @MaxJPRey @jwinkle8