-
-
Notifications
You must be signed in to change notification settings - Fork 17.9k
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Update pydata-sphinx-theme to 0.14 #55885
Conversation
I think you need to update |
requirements-dev.txt
Outdated
@@ -59,7 +59,7 @@ gitdb | |||
google-auth | |||
natsort | |||
numpydoc | |||
pydata-sphinx-theme==0.13 | |||
pydata-sphinx-theme>=0.14 |
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 would personally prefer to bump the pin, and not unpin. For dependencies like this where appearance might change, I think it is good to keep a pinned version (and our deployed docs are more like an application), and consciously update the pin from time to time, checking that everything is still working as expected.
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.
That's a good point. Given how often this theme changes and APIs change it's better to pin
Hmm I'm not familiar with how the version switcher works (or if it's supposed to work locally) so could you explain the specific issue? |
Going to keep this for the next release (I still have to test it locally a bit more for the switcher version), so broke off the numpy code block change to #55911 |
It's difficult to test locally (you need a released version to see it in practice), but so I pushed a commit that I think will make it work, based on my knowledge of fixing it for arrow. |
doc/source/conf.py
Outdated
"navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"], | ||
"sidebar_includehidden": False, |
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.
Did you add this for a specific reason? (locally I am not directly seeing a difference)
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.
Ah I thought this was needed before because the empty sidebar misaligned the body of the page, but looks like this isn't needed anymore
The light/dark theme switcher also seems to be missing |
So looks like the light/dark theme switcher is still in the html
Locally I had to comment out the |
/preview |
No preview found for PR #55885. Did the docs build complete? |
The preview seems to have worked: http://pandas.pydata.org/preview/55885/docs/ |
I see a few glitches I would report upstream, but I suppose this is good enough to merge for the RC. We still have some time to fixup a few things before the final release |
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.
Thanks @mroeschke
* DEPS: Unpin pydata-sphinx-theme * Pin to 0.14 * update switcher_version * Add preferred version --------- Co-authored-by: Joris Van den Bossche <[email protected]> Co-authored-by: Thomas Li <[email protected]>
Also uses a code block for an numpy operation that will change/fail with a newer version of numpy