DOC: apply toc styling to remove nesting #28557
Conversation
|
failures unrelated b/c this is pure docs |
|
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;
|
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.
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.
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?
15d2b30 to
9bef3f1
Compare
change "new contributors" section title to "contributing guide" add copy to anchor each section of devel/index small doc cleanups based on above
|
self merged based on approval from @timhoffm #28557 (review) |
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