Fix rstcheck failures by rcomer · Pull Request #30810 · matplotlib/matplotlib · GitHub
Skip to content

Fix rstcheck failures - #30810

Merged
tacaswell merged 1 commit into
matplotlib:mainfrom
rcomer:rst-ci
Dec 4, 2025
Merged

tacaswell merged 1 commit into
matplotlib:mainfrom
rcomer:rst-ci

Conversation

@rcomer

@rcomer rcomer commented Dec 4, 2025

Copy link
Copy Markdown
Member

PR summary

Recently the CI linting task has been failing in the rstcheck step, maybe because Sphinx just cut a major release. It seems the checker is now very strict about not duplicating references. This means not creating more than one handle for the same url and also not creating a handle with the same name as a subheading ("community" in contribute.rst).

PR checklist

@github-actions github-actions Bot added Documentation: devdocs files in doc/devel Documentation: API files in lib/ and doc/api labels Dec 4, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Note: We typically use .. code-block:: not .. code::. I'm unclear whether this makes a difference.

@rcomer rcomer Dec 4, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We have one instance without a language, and it is not causing an error

Should I change this to code-block? Do we want it with or without syntax highlighting?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Actually it already has syntax highlighting in the stable docs.
https://matplotlib.org/stable/api/toolkits/mplot3d/view_angles.html#rotation-with-mouse

@rcomer

rcomer commented Dec 4, 2025

Copy link
Copy Markdown
Member Author

Oh, it looks like these "new" errors may just be a re-wording of one we previously ignored

"Duplicate explicit target name: \".*\".",

@story645 I see you originally added this checker. Did you ignore this because you disagree with this rule?

@story645

story645 commented Dec 4, 2025

Copy link
Copy Markdown
Member

@story645 story645 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks for fixing this!

@tacaswell tacaswell modified the milestones: v3.10-doc, v3.11.0 Dec 4, 2025
@tacaswell
tacaswell merged commit de6e548 into matplotlib:main Dec 4, 2025
21 checks passed
@rcomer
rcomer deleted the rst-ci branch December 4, 2025 21:19
has2k1 pushed a commit to has2k1/matplotlib that referenced this pull request Dec 11, 2025
andreas16700 added a commit to andreas16700/matplotlib that referenced this pull request Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: API files in lib/ and doc/api Documentation: devdocs files in doc/devel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants