dask / dask-sphinx-theme

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

Pin `sphinx_rtd_theme >= 0.5.2` #52

Closed jrbourbeau closed 3 years ago

jrbourbeau commented 3 years ago

The recent docutils 0.17 release has some incompatibility issues with sphinx_rtd_theme which causes things like, for example bulleted lists, to be rendered incorrectly (https://github.com/readthedocs/sphinx_rtd_theme/issues/1115). The PR ensures that we're using the latest sphinx_rtd_theme release, which handles pinning docutils<0.17.

NOTE: The reason I'm proposing we pin sphinx_rtd_theme instead of docutils directly is that I recently discovered readthedocs.org implicitly pins sphinx-rtd-theme<0.5 (xref https://github.com/readthedocs/readthedocs.org/issues/8230), which can lead to discrepancies between local and remote documentation builds. Pinning sphinx_rtd_theme >= 0.5.2 as this PR suggests will allow us to both avoid the docutils=0.17 rendering issue as well as minimize discrepancies between local builds and what happends on readthedocs.org