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

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.

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

rcomer merged 3 commits intomatplotlib:mainfromjklymak:doc-cards-user-explain

Jun 18, 2023

Merged

Doc cards user explain#26141

rcomer merged 3 commits intomatplotlib:mainfromjklymak:doc-cards-user-explain

Jun 18, 2023

Conversation

Copy link

Member

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

"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

jklymak added3 commits

June 17, 2023 11:26

DOC: visible TOC to the sphinx gallery user/explain READMEs

07434e2

Note this is manual.  I don't think there is an automatic way to makethese visible.

DOC: make user/explain/index cards

e96ee1f

DOC: make user/explain/index cards

fd4d960

jklymak force-pushed thedoc-cards-user-explain branch fromdb3c58a tofd4d960Compare

June 18, 2023 01:32

Copy link

MemberAuthor

jklymak commentedJun 18, 2023

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

Copy link

Member

rcomer commentedJun 18, 2023

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

Copy link

MemberAuthor

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.