Skip to content

Temporarily pin down Sphinx to work around RTD bug#434

Merged
joshmoore merged 1 commit intozarr-developers:mainfrom
DimitriPapadopoulos:docs
May 7, 2023
Merged

Temporarily pin down Sphinx to work around RTD bug#434
joshmoore merged 1 commit intozarr-developers:mainfrom
DimitriPapadopoulos:docs

Conversation

@DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented May 6, 2023

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)

@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
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
6 tasks
QuLogic added a commit to QuLogic/numcodecs that referenced this pull request Jul 21, 2024
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
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
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs don't build any more with Sphinx 7.0.0

3 participants