search

spotipy-dev / spotipy

A light weight Python library for the Spotify Web API
http://spotipy.readthedocs.org
MIT License
5.03k stars 957 forks source link

Update sphinx requirement from ~=7.4.7 to ~=8.0.2 #1152

Open dependabot[bot] opened 3 months ago

dependabot[bot] commented 3 months ago

Updates the requirements on sphinx to permit the latest version.

Release notes

Sourced from sphinx's releases.

Sphinx 8.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 8.0.2 (released Jul 30, 2024)

Bugs fixed

  • Fix the pygments.Formatter.__class_getitem__ patch. Patch by Adam Turner.

Release 8.0.1 (released Jul 30, 2024)

Bugs fixed

  • Patch pygments.Formatter.__class_getitem__ in Pygments 2.17. Patch by Adam Turner.

Release 8.0.0 (released Jul 29, 2024)

Dependencies

  • #12633: Drop Python 3.9 support.

Incompatible changes

.. rst-class:: compact

  • Remove deprecated functions from sphinx.util:

    • Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize).
    • Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk).
    • Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator).
    • Removed sphinx.util.SkipProgressMessage (use sphinx.util.display.SkipProgressMessage).
    • Removed sphinx.util.progress_message (use sphinx.util.display.progress_message).
    • Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123).
    • Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch).
    • Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback).
    • Removed sphinx.util.format_exception_cut_frames

... (truncated)

Commits


Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
dieser-niko commented 3 months ago

sphinx-rtd-theme needs to support Sphinx 8. https://github.com/readthedocs/sphinx_rtd_theme/issues/1582

humitos commented 3 months ago

We released a new version 3.0.0rc1 that adds support for latest Sphinx versions. Please, give it a try and open an issue for any problem or feedback you want to share with us.

dieser-niko commented 1 month ago

Alright, it seems that the version select footer is no longer enabled by default (which looks like this) according to https://github.com/readthedocs/sphinx_rtd_theme/issues/1598 and needs to be enabled as an addon. In our case here: https://app.readthedocs.org/dashboard/spotipy/addons/edit/

I'm not really happy with this change as it puts the version select footer in the right corner. It also affects older versions, not just this pull request/branch here. The mentioned issue also seems to suggest that I could change this in the sphinx config, but it didn't work for me, so I reverted it.

Overall, this change seems to be fully intentional (even with the version selector in the "wrong" corner), as this change is visible in their own documentation: https://docs.readthedocs.io

@stephanebruckert If you want, you can check out the new look by simply enabling add-ons as mentioned at the beginning. You don't need to look at a specific version of the docs, it looks the same for every version.

humitos commented 1 month ago

We just released version 3.0.0 of Read the Docs theme. It integrates the version and language selectors at the top left inside the navbar, below the title of the docs:

Peek 2024-10-07 10-36

Also note that today we enabled Read the Docs Addons by default as planned: https://about.readthedocs.com/blog/2024/07/addons-by-default/

dieser-niko commented 1 month ago

@humitos what about this thing here? It bothers me somewhat because it just doesn't fit in with the background.

image

humitos commented 1 month ago

@dieser-niko you can disable it if you want. To do that,

  1. go to the new dashboard https://app.readthedocs.org/
  2. go to settings of your project
  3. click on "Addons"
  4. click on "Flyout"
  5. uncheck "Flyout enabled"

Screenshot_2024-10-07_11-35-28

dependabot[bot] commented 1 month ago

A newer version of sphinx exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.