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.

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

Jump to bottom

Temporarily pin down Sphinx to work around RTD bug #434

Merged
merged 1 commit into from
May 7, 2023
Merged

Temporarily pin down Sphinx to work around RTD bug #434

merged 1 commit into from
May 7, 2023

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented May 6, 2023 •
edited
Loading

Fixes #433.

The RTD theme is not compatible with Sphinx 7.0.0. Pin down Sphinx until RTD fix this compatibility issue.

The alternative is to force a different theme as in freeipa/freeipa#6812.

TODO:

  • Unit tests and/or doctests in docstrings
  • Tests pass locally
  • Docstrings and API docs for any new/modified user-facing classes and functions
  • Changes documented in docs/release.rst
  • Docs build locally
  • GitHub Actions CI passes
  • Test coverage to 100% (Codecov passes)

@DimitriPapadopoulos DimitriPapadopoulos mentioned this pull request May 6, 2023
Merged
7 tasks
@joshmoore joshmoore mentioned this pull request May 7, 2023
Closed
@joshmoore
Copy link
Member

Thanks, @DimitriPapadopoulos! Let's go with the pin. I've created #435 as a reminder to review things down the road.

@joshmoore joshmoore merged commit 8d2bac0 into zarr-developers:main May 7, 2023
@DimitriPapadopoulos DimitriPapadopoulos deleted the docs branch May 7, 2023 13:04
QuLogic added a commit to QuLogic/numcodecs that referenced this pull request Jul 21, 2024
@QuLogic
Remove Sphinx pinning
5d1151a 
This was pinned in zarr-developers#434 because of the RTD theme, but zarr-developers#485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes zarr-developers#435
@QuLogic QuLogic mentioned this pull request Jul 21, 2024
Merged
6 tasks
QuLogic added a commit to QuLogic/numcodecs that referenced this pull request Jul 21, 2024
@QuLogic
Remove Sphinx pinning
94c2bf1 
This was pinned in zarr-developers#434 because of the RTD theme, but zarr-developers#485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes zarr-developers#435
QuLogic added a commit to QuLogic/numcodecs that referenced this pull request Jul 21, 2024
@QuLogic
Remove Sphinx pinning
189d0cf 
This was pinned in zarr-developers#434 because of the RTD theme, but zarr-developers#485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes zarr-developers#435
dstansby pushed a commit that referenced this pull request Aug 11, 2024
@QuLogic
Remove Sphinx pinning (#552)
8b53fc1 
This was pinned in #434 because of the RTD theme, but #485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes #435
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
needs release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs don't build any more with Sphinx 7.0.0
2 participants
@DimitriPapadopoulos @joshmoore