dask / dask-sphinx-theme

Sphinx theme for Dask documentation
BSD 3-Clause "New" or "Revised" License
6 stars 15 forks source link

Theme fails to style api docs with `sphinx-rtd-theme==0.5.0` #44

Closed jcrist closed 2 years ago

jcrist commented 3 years ago

The latest version of sphinx-rtd-theme (which dask-sphinx-theme is built on) is 0.5.0. With that installed, api docs fail to style properly.

With sphinx-rtd-theme==0.5.0

Screen Shot 2020-10-02 at 5 14 36 PM

With sphinx-rtd-theme==0.4.3

Screen Shot 2020-10-02 at 5 14 25 PM

When using sphinx-rtd-theme==0.5.0 instead of dask-sphinx-theme things work properly, so it's something about the dask theme itself that breaks things. For now I'm pinning to 0.4.3 in dask-gateway to workaround the issue.

mrocklin commented 3 years ago

cc @gforsyth :)

gforsyth commented 3 years ago

I think I might've fixed this already? @jcrist was this with dask-sphinx-theme==1.3.3?

On my machine with:

$ conda list | grep sphinx                                                                                            
dask-sphinx-theme         1.3.3                    pypi_0    pypi
sphinx                    3.2.1                      py_0    conda-forge
sphinx-rtd-theme          0.5.0                    pypi_0    pypi

and building dask-gateway docs from current master I see:

2020-10-03-104636_736x593_scrot

jsignell commented 2 years ago

Closing this since #54 moves us to be based off of exectuable-books-theme