Skip to content
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

DEP: Remove docutils upper-pin, bump sphinx #739

Merged
merged 1 commit into from
May 1, 2024

Conversation

agriyakhetarpal
Copy link
Collaborator

@agriyakhetarpal agriyakhetarpal commented May 1, 2024

Description

This PR is a follow-up from #737 to bump some documentation-related dependencies in util/readthedocs/requirements.txt, as requested in #737 (review).

Changes made

  1. Added a minimum version requirement for sphinx – set to >=7`
  2. Removed the constraint from docutils – it was the one that was blocking this change.

Additional context

I checked many of the pages personally and there seem to be no problems with the build. The documentation does not display any warnings and the build with -W passes locally. All of our extensions and other listed dependencies support Sphinx v7 as well.

This commit bumps the version of Sphinx
to 7 by relaxing the requirement on the version
of docutils. This allows building the docs with
a higher version of Sphinx on RTD and locally.
@agriyakhetarpal
Copy link
Collaborator Author

Logs from Read the Docs dashboard: https://beta.readthedocs.org/projects/pywavelets/builds/24244868/

The build passes here as well, no warnings emitted.

@rgommers rgommers added this to the v1.7.0 milestone May 1, 2024
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @agriyakhetarpal!

@rgommers rgommers merged commit f41261e into PyWavelets:main May 1, 2024
16 checks passed
@agriyakhetarpal agriyakhetarpal deleted the bump-to-latest-sphinx branch May 1, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants