Skip to content

DOC: fix artist see also sections#30266

Merged
jklymak merged 1 commit into
matplotlib:mainfrom
rcomer:artist-seealso
Jul 6, 2025
Merged

DOC: fix artist see also sections#30266
jklymak merged 1 commit into
matplotlib:mainfrom
rcomer:artist-seealso

Conversation

@rcomer

@rcomer rcomer commented Jul 5, 2025

Copy link
Copy Markdown
Member

PR summary

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

PR checklist

@rcomer rcomer added the Documentation: API files in lib/ and doc/api label Jul 5, 2025
@github-actions github-actions Bot removed the Documentation: API files in lib/ and doc/api label Jul 5, 2025
@rcomer rcomer marked this pull request as draft July 5, 2025 18:51
@rcomer rcomer marked this pull request as ready for review July 5, 2025 19:54
@rcomer

rcomer commented Jul 5, 2025

Copy link
Copy Markdown
Member Author

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.)

jkseppan
jkseppan approved these changes Jul 6, 2025
View reviewed changes

@jkseppan jkseppan 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.

Looks good: https://output.circle-artifacts.com/output/job/ff3a0a96-024e-41b4-99f8-8898f181b132/artifacts/0/doc/build/html/api/_as_gen/matplotlib.artist.Artist.get_window_extent.html#matplotlib.artist.Artist.get_window_extent

@jklymak jklymak merged commit 90db4c1 into matplotlib:main Jul 6, 2025
40 checks passed
@rcomer rcomer deleted the artist-seealso branch July 6, 2025 16:22
@QuLogic QuLogic added this to the v3.11.0 milestone Jul 7, 2025
@QuLogic QuLogic added the Documentation: API files in lib/ and doc/api label Jul 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jkseppan jkseppan jkseppan approved these changes

Assignees

No one assigned

Labels

Documentation: API files in lib/ and doc/api

Projects

None yet

Milestone

v3.11.0

Development

Successfully merging this pull request may close these issues.

4 participants

@rcomer @jkseppan @QuLogic @jklymak