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

Bump pydata-sphinx-theme#27658

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
jklymak merged 7 commits intomatplotlib:mainfromdstansby:pydata-version
Mar 7, 2024
Merged

Conversation

dstansby
Copy link
Member

@dstansbydstansby commentedJan 16, 2024
edited
Loading

PR summary

The goal of this PR is to bumppydata-shpinx-theme, so we can take advantage of improvements/bug fixes that have happened since version 0.13.

Things that arecurrently broken now fixed:

  • Light/dark theme button
  • Search button - working fine in a build ofmpl-sphinx-theme, so there must be something funny going on inmatplotlib itself that is stopping this from working... update 1: it'sversion-switcher.html that's breaking this somehow. update 2: I thinkSearch button/field broken on local development build pydata/pydata-sphinx-theme#1654 is the upstream issue here
  • Version switcher doesn't say "devdocs"
  • Section navigation missing

Fixes#27652
Fixesmatplotlib/mpl-sphinx-theme#80

PR checklist

@github-actionsgithub-actionsbot added the Documentation: buildbuilding the docs labelJan 16, 2024
@dstansbydstansby changed the titleBump pydata-sphinx-theme to 0.15Bump pydata-sphinx-themeJan 17, 2024
@github-actionsgithub-actionsbot added Documentation: devdocsfiles in doc/devel Documentation: user guidefiles in galleries/users_explain or doc/users Documentation: APIfiles in lib/ and doc/api labelsJan 19, 2024
@dstansbydstansbyforce-pushed thepydata-version branch 2 times, most recently from5219372 to149374aCompareJanuary 19, 2024 18:56
@github-actionsgithub-actionsbot removed Documentation: devdocsfiles in doc/devel Documentation: user guidefiles in galleries/users_explain or doc/users Documentation: APIfiles in lib/ and doc/api labelsJan 19, 2024
@dstansbydstansbyforce-pushed thepydata-version branch 2 times, most recently fromc66acba to9ec03b7CompareFebruary 17, 2024 10:05
@dstansbydstansbyforce-pushed thepydata-version branch 2 times, most recently from4c030e9 tod369a06CompareMarch 4, 2024 21:00
@@ -147,7 +147,7 @@ commands:
export RELEASE_TAG='-t release'
fi
mkdir -p logs
make html O="-T $RELEASE_TAG -j4 -w /tmp/sphinxerrorswarnings.log"
make html O="-T $RELEASE_TAG -j1 -w /tmp/sphinxerrorswarnings.log"
Copy link
MemberAuthor

Choose a reason for hiding this comment

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

This change is becausepydata-sphinx-theme doesn't support parallel writes:pydata/pydata-sphinx-theme#1643. It doesn't seem to impact build time significantly though,18m19s before and18m57s after.

Copy link
Member

@timhoffmtimhoffmMar 5, 2024
edited
Loading

Choose a reason for hiding this comment

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

Not tested with the new version, but IIRC, I got significant speedups on my local machine with -j4. If we can't have that anymore, we need to updatehttps://matplotlib.org/devdocs/devel/document.html#build-the-docs. Also, > 10min doc build times makes working on docs very unattractive. Assomebody else said

In practice, that goes from "let me quickly build the docs to see the effect of this change" to "let's just hope it renders correctly".

Are the other improvements so significant that we are willing to take this on?

Edit: or is the above comparison old version -j4 vs. new version -j1. There were other performance improvements in the pydata Sphinx theme that might just compensate the losses of non-parallel builds.

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

The comparison is on circleCI between591cd65 andf178f5c, the only difference being changing-j4 to-j1. Perhaps even with-j4 circleCI wasn't using any parallelism to build the docs?

Are the other improvements so significant that we are willing to take this on?

They include at least some accesibility improvements which I would advocate for.

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Note that this is changing the parallel option only for the circleCI build, not any local or other builds, so the comparison using only times measured on circleCI is fair.

timhoffm 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.

And you can still use parallel options, it will just raise a warning at the end of the doc build thatpydata-sphinx-theme isn't parallel write safe.

timhoffm reacted with thumbs up emoji
Copy link
Member

Choose a reason for hiding this comment

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

I don't see any need to change our call here. The theme marks it self as parallel-unsafe, so requesting parallel build will be turned off anyway. And then when they fix themselves, we'd need to remember to turn it back on again.

Copy link
MemberAuthor

@dstansbydstansbyMar 5, 2024
edited
Loading

Choose a reason for hiding this comment

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

Without using-j1, shpinx emits a warning that the theme isn't parallel write safe, which fails the build. Ideally there would be a way to ignore just this warning and use-j4, but I'm not aware if that's possible with sphinx?

Copy link
Member

Choose a reason for hiding this comment

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

You could try to add a warnings filter to conf.py

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Do you mean thesuppress_warnings configuration? It seems to be the only relevant option to do this, but warning about a non-parallel write safe theme doesn't seem to be convered by the list of warning types that can be suppressed.

@@ -14,29 +14,6 @@
margin: 0;
}

/* Make announcement an error colour for unreleased documentation, and sticky. */
Copy link
MemberAuthor

Choose a reason for hiding this comment

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

This CSS interacts badly with dark mode, and removing it (and defaulting to whatpydata-sphinx-theme uses) looks fine.

@dstansby
Copy link
MemberAuthor

After much force pushing I think this is finally ready for review!

@dstansbydstansby marked this pull request as ready for reviewMarch 5, 2024 09:24
@timhoffm
Copy link
Member

timhoffm commentedMar 5, 2024
edited
Loading

TL;DR I’m just stating my discomfort, not suggesting to block or do anything about it.

On a general note, I'm a bit annoyed that every link is now underlined. While this is required for accessibilitypydata/pydata-sphinx-theme#1353 and makes sense for regular links, it's rather distracting in gallery code:

grafik
But 🤷 .

@jklymak
Copy link
Member

I'm not thrilled with the new pydata theme either. I suppose we can customize somewhat and maybe there is a css entry for the gallery entries?

@dstansby
Copy link
MemberAuthor

FWIW I quite like the link underlining in the gallery code - there's lots I didn't realise were there before they were underlined! I wouldn't block a PR to change that though.

@jklymak are there any specific bits you don't like?

@jklymak
Copy link
Member

In particular, not a fan of underlining anywhere except in very rare circumstances. But I appreciate that many web sites use this.

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.

I suggest to postpone the style discussion and merge this soon. I believe all above mentioned shortcomings are not blockers. And it's easier to find issues and work on improvements when the new version is in our active build.

jklymak reacted with thumbs up emoji
@jklymakjklymak merged commit668c4c4 intomatplotlib:mainMar 7, 2024
@timhoffm
Copy link
Member

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic left review comments

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Labels
Documentation: buildbuilding the docs
Projects
None yet
Milestone
v3.9.0
Development

Successfully merging this pull request may close these issues.

[Doc]: Low contrast on clicked links in dark mode pydata_sphinx_theme 0.14.1 breaks current website look
4 participants
@dstansby@timhoffm@jklymak@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp