Skip to content

Doc cards user explain #26141

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
Merged
merged 3 commits into from
Jun 18, 2023
Merged

Doc cards user explain #26141

merged 3 commits into from
Jun 18, 2023

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Jun 17, 2023

PR summary

  • This PR adds a visible TOC to the galleries in users/explain (color, animations, text).
  • This PR makes each subject in users/explain/index a card with depth = 2 table of contents.

Follow up to #26110

PR checklist

@jklymak jklymak force-pushed the doc-cards-user-explain branch from db3c58a to fd4d960 Compare June 18, 2023 01:32
@jklymak
Copy link
Member Author

jklymak commented Jun 18, 2023

https://output.circle-artifacts.com/output/job/4ebd326b-04c5-48e8-89cb-64ab047d3c0c/artifacts/0/doc/build/html/users/explain/index.html
look

@rcomer
Copy link
Member

rcomer commented Jun 18, 2023

Are we expecting to populate the Axis section in time for the 3.8 release? If not, would it be better to hide that from this top level index for now?

@jklymak
Copy link
Member Author

jklymak commented Jun 18, 2023

I think we need something like an axis section. I got started and axis/axes/spines are all pretty intertwined so maybe it all has to go under axes. However this will be done before 3.8 is finalized, though before the rc is unlikely.

rcomer
rcomer approved these changes Jun 18, 2023
View reviewed changes
Copy link
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

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

In that case, this looks good to me.

@rcomer rcomer added this to the v3.8.0 milestone Jun 18, 2023
@rcomer rcomer merged commit a73c347 into matplotlib:main Jun 18, 2023
@jklymak jklymak deleted the doc-cards-user-explain branch June 18, 2023 13:17
@jklymak jklymak mentioned this pull request Jul 5, 2023
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rcomer rcomer rcomer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.8.0
Development

Successfully merging this pull request may close these issues.
2 participants
@jklymak @rcomer