I've observed this to be leading to errors in building docs.

dask-sphinx-theme pins sphinx-book-theme==0.2.0 still, and that makes us stuck at sphinx>=3,<5, and that now has observed to lead to the error below in dask/dask-gateway:

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.
make: *** [Makefile:20: html] Error 2

Note that dask/dask-gateway doesn't itself enable sphinxcontrib.applehelp, and I've not seen it mentioned by either dask-sphinx-theme or its dependent sphinx-book-theme.

Okay it seems to stem from sphinx itself, and sphinxcontrib-applehelp 1.0.5 introduced the breaking change as seen here.

Requirement already satisfied: sphinxcontrib-applehelp in /home/erik/miniforge3/lib/python3.10/site-packages (from sphinx<5,>=3->sphinx-book-theme==0.2.0->dask-sphinx-theme) (1.0.8)

It appears that multiple dependencies installed by sphinx require sphinx>=5, so a simpler workaround like pinning sphinxcontrib-applehelp<1.0.5 doesn't work.

Workaround

This docs requirements.txt addition to dask/dask-gateway's docs dependencies made its CI build succeed again:

# FIXME: This workaround is required until we have sphinx>=5, as enabled by
#        dask-sphinx-theme no longer pinning sphinx-book-theme==0.2.0. This is
#        tracked in https://github.com/dask/dask-sphinx-theme/issues/68.
#
sphinxcontrib-applehelp<1.0.5
sphinxcontrib-devhelp<1.0.6
sphinxcontrib-htmlhelp<2.0.5
sphinxcontrib-serializinghtml<1.1.10
sphinxcontrib-qthelp<1.0.7

Uh oh!

Updating sphinx-book-theme version pinning #68

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Updating `sphinx-book-theme` version pinning #68