Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: apply toc styling to remove nesting#28557
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
Uh oh!
There was an error while loading.Please reload this page.
Conversation
failures unrelated b/c this is pure docs |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
story645 commentedJul 18, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
So, of course this PR has run away into some bigger content changes 🤦♀️:
Like I mentioned in this comment, I'm trying to avoid major restructure territory because I've got a rough plan (that yes, I figure will be up for discussion) for more clean up/polishing and this was supposed to be a "yay, new CSS style!" PR:
graph TD; A(is the issue) -->unresolvable-->C(explain why <br /> technically infeasible <br /> or not aligned with <br /> values/mission/scope/etc); A-->resolved--> B(explain why, <br /> link to docs, API, etc) ; A-->resolvable-->D(work w/ issue author <br /> on an implementable <br /> code/docs solution) A-->E(not sure)-->F(ask for more information) -->A; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Take or leave the comments. Can self-merge afterwards.
Uh oh!
There was an error while loading.Please reload this page.
environment.yml Outdated
@@ -37,7 +37,7 @@ dependencies: | |||
- packaging>=20 | |||
- pydata-sphinx-theme~=0.15.0 | |||
- pyyaml | |||
- sphinx>=3.0.0,!=6.1.2 | |||
- sphinx>=7.4.0,!=6.1.2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Not sure we want to be that aggressive. On a technical side, it's ok. The only concern is that we break every dev envionment out there. When this is in, if somebody does a rebase onto master, their sphinx-build will fail because their dev env has an older version of sphinx and cannot handle:class:
in.. toctree:
. I'd slightly prefer to still go with the.. rst-class
variant for now, and change some time in the future.
Sorry if my comment has made you believe I advocate for switching right now. But please decide yourself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'll change it back, I'm very : shrugs: about this, but what is our timeline for migrating given that we currently set our min to 3.0? Is it gonna depend more on the sphinx gallery min?
Uh oh!
There was an error while loading.Please reload this page.
15d2b30
to9bef3f1
Comparechange "new contributors" section title to "contributing guide"add copy to anchor each section of devel/indexsmall doc cleanups based on above
0eb624d
intomatplotlib:mainUh oh!
There was an error while loading.Please reload this page.
self merged based on approval from@timhoffm#28557 (review) |
Uh oh!
There was an error while loading.Please reload this page.
PR summary
Use section-toc css class to strip out the page title/nesting for the toctrees where the page is already given by the section title.
Here's one example, but I think it makes the page look cleaner:
PR checklist