Skip to content

DOC: Update pydata-sphinx-theme to 0.14 #55885

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.

Sign up for GitHub

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

Merged
lithomas1 merged 9 commits into from
Dec 22, 2023
Merged

DOC: Update pydata-sphinx-theme to 0.14 #55885

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
32a1517
DEPS: Unpin pydata-sphinx-theme
mroeschke Nov 8, 2023
079122f
Merge remote-tracking branch 'upstream/main' into docs/pst/unpin
mroeschke Nov 8, 2023
33b8e79
Merge remote-tracking branch 'upstream/main' into docs/pst/unpin
mroeschke Nov 9, 2023
93afd21
Pin to 0.14
mroeschke Nov 9, 2023
68c7f08
update switcher_version
jorisvandenbossche Nov 10, 2023
bc09e01
Merge remote-tracking branch 'upstream/main' into docs/pst/unpin
mroeschke Nov 21, 2023
24dec55
Merge remote-tracking branch 'upstream/main' into docs/pst/unpin
mroeschke Dec 11, 2023
30438b6
Add preferred version
mroeschke Dec 12, 2023
987e73a
Merge branch 'main' into docs/pst/unpin
lithomas1 Dec 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,9 @@
"plausible_analytics_url": "https://views.scientific-python.org/js/script.js",
},
"logo": {"image_dark": "https://pandas.pydata.org/static/img/pandas_white.svg"},
"navbar_align": "left",
"navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
"sidebar_includehidden": False,
Copy link
Member

@jorisvandenbossche jorisvandenbossche Nov 10, 2023

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)

Copy link
Member Author

@mroeschke mroeschke Dec 12, 2023

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

"switcher": {
"json_url": "https://pandas.pydata.org/versions.json",
"version_match": switcher_version,
Expand Down
7 changes: 4 additions & 3 deletions doc/source/whatsnew/v0.17.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,10 +727,11 @@ be broadcast:

or it can return False if broadcasting can not be done:

.. ipython:: python
:okwarning:
.. code-block:: ipython

In [11]: np.array([1, 2, 3]) == np.array([1, 2])

np.array([1, 2, 3]) == np.array([1, 2])
Out[11]: False

Changes to boolean comparisons vs. None
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ dependencies:
- google-auth
- natsort # DataFrame.sort_values doctest
- numpydoc
- pydata-sphinx-theme=0.13
- pydata-sphinx-theme>=0.14
- pytest-cython # doctest
- sphinx
- sphinx-design
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ gitdb
google-auth
natsort
numpydoc
pydata-sphinx-theme==0.13
pydata-sphinx-theme>=0.14
Copy link
Member

@jorisvandenbossche jorisvandenbossche Nov 9, 2023

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.

Copy link
Member Author

@mroeschke mroeschke Nov 9, 2023

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

pytest-cython
sphinx
sphinx-design
Expand Down