Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
story645 merged 1 commit intomatplotlib:mainfromstory645:landing-page
Jul 23, 2024

Conversation

story645
Copy link
Member

@story645story645 commentedJul 12, 2024
edited
Loading

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:

oldnew
imageimage

PR checklist

@story645
Copy link
MemberAuthor

failures unrelated b/c this is pure docs

@story645story645 added the Documentation: websitelayout/behavior/styling changes labelJul 15, 2024
@story645
Copy link
MemberAuthor

story645 commentedJul 18, 2024
edited
Loading

So, of course this PR has run away into some bigger content changes 🤦‍♀️:

  • upgrades to sphinx 7.4.0 branch (this may require updates to sphinx gallery)
  • added link to devel/index to landingpage contribute copy
  • changes section title: "new contributors"->"contributing guide"
    • am slightly ambivalent about this change, but am thinking maybe it'll be more read if it's not cast as only for newbies b/c it's purpose is more so to provide information on what can be contributed, where/how, and what resources are available for contributors
  • pulled some copy out of triage to anchor the new "issues" section.
  • tightened up the "submit bug" and "new issue" buttons cause I thought the stuff I cut was either redundant or applied to both.
  • inspired by new issues copy, unraveled the "new contributors should xyz" paragraph to instead add copy to each section on why someone should read it -> new contributors get guidance and experienced contributors can skim/skip to links.

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;
Loading

@github-actionsgithub-actionsbot added the Documentation: devdocsfiles in doc/devel labelJul 18, 2024
Copy link
Member

@timhoffmtimhoffm left a 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.

story645 reacted with thumbs up emoji
@@ -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
Copy link
Member

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.

story645 reacted with thumbs up emoji
Copy link
MemberAuthor

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?

@story645story645force-pushed thelanding-page branch 2 times, most recently from15d2b30 to9bef3f1CompareJuly 18, 2024 15:38
@story645story645 changed the titleapplying toc styling to remove nestingDOC: apply toc styling to remove nestingJul 18, 2024
@story645story645 mentioned this pull requestJul 18, 2024
11 tasks
change "new contributors" section title to "contributing guide"add copy to anchor each section of devel/indexsmall doc cleanups based on above
@story645story645 merged commit0eb624d intomatplotlib:mainJul 23, 2024
31 of 32 checks passed
@story645
Copy link
MemberAuthor

self merged based on approval from@timhoffm#28557 (review)

@story645story645 deleted the landing-page branchJuly 23, 2024 05:23
@QuLogicQuLogic added this to thev3.10.0 milestoneJul 23, 2024
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Labels
Documentation: devdocsfiles in doc/develDocumentation: websitelayout/behavior/styling changes
Projects
None yet
Milestone
v3.10.0
Development

Successfully merging this pull request may close these issues.

3 participants
@story645@timhoffm@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp