NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

DOC: fix artist see also sections#30266

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

jklymak merged 1 commit intomatplotlib:mainfromrcomer:artist-seealso

Jul 6, 2025

Merged

DOC: fix artist see also sections#30266

jklymak merged 1 commit intomatplotlib:mainfromrcomer:artist-seealso

Jul 6, 2025

+2 −2

Conversation

Copy link

Member

rcomer commentedJul 5, 2025

PR summary

Sphinx doesn't seem to like the link syntax within the see also section. This update works for me locally.

PR checklist

"closes #0000" is in the body of the PR description tolink the related issue
new and changed code istested
Plotting related features are demonstrated in anexample
New Features andAPI Changes are noted with adirective and release note
Documentation complies withgeneral anddocstring guidelines

rcomer added the Documentation: APIfiles in lib/ and doc/api label

Jul 5, 2025

github-actionsbot removed the Documentation: APIfiles in lib/ and doc/api label

Jul 5, 2025

rcomer marked this pull request as draft

July 5, 2025 18:51

DOC: fix artist see also sections

9c3f73b

rcomer force-pushed theartist-seealso branch from41fbc2b to9c3f73bCompare

July 5, 2025 19:41

rcomer marked this pull request as ready for review

July 5, 2025 19:54

Copy link

MemberAuthor

rcomer commentedJul 5, 2025

I also tried with the leading tilde locally but

Handler <function mangle_signature at 0x75a104501580> for event 'autodoc-process-signature' threw an exception (exception: Error parsing See Also entry '~.Artist.get_tightbbox :' in the docstring of get_window_extent in /home/ruth/git_stuff/matplotlib/lib/matplotlib/artist.py.)