Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Doc]: turn anatomy figure into clickable table of contents #26963

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
story645 opened this issue Sep 29, 2023 · 4 comments
Open

[Doc]: turn anatomy figure into clickable table of contents #26963

story645 opened this issue Sep 29, 2023 · 4 comments
Labels
Documentation: user guide files in galleries/users_explain or doc/users Documentation

Comments

@story645
Copy link
Member

story645 commented Sep 29, 2023 •
edited
Loading

Documentation Link

https://matplotlib.org/stable/users/explain/quick_start.html#parts-of-a-figure

Problem

It's not always clear what Matplotlib names things, so it could be really useful if the anatomy figure could be marked up as an svg with links to the relevant user guide sections.

sphx_glr_anatomy_001

Related to (or alt to) #26205, but building on the idea of using the Anatomy figure as the scoping for the userguide.
@story645 story645 added Documentation Documentation: user guide files in galleries/users_explain or doc/users labels Sep 29, 2023
@QuLogic
Copy link
Member

QuLogic commented Sep 30, 2023

We had some issues with generating example images in SVG, but if that could be fixed, this could be done relatively easily by calling .set_url on all the artists you wanted linked.

@GAuravY19
Copy link

Hi sir,

I am interested in trying my hands over this issue.

@GAuravY19
Copy link

GAuravY19 commented Oct 1, 2023 •
edited
Loading

But I need clarification on the issue.

Is it necessary to convert the image into SVG one or can I go with img?

Also is it similar to doing image mapping in html ...?

@story645
Copy link
Member Author

story645 commented Oct 2, 2023

Also is it similar to doing image mapping in html

Same effect, but programmatically using the .set_url method on every element of the image so that the urls can be turned to the document version. This PR is really straightforward if you know what a Matplotib Artist is & overly complicated if you don't.

but the question that @QuLogic is raising is that if may not work at all b/c we've been having trouble

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation: user guide files in galleries/users_explain or doc/users Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@QuLogic @story645 @GAuravY19