Doesn't work out-of-the-box on https://readthedocs.org/ when using the sphinx_rtd_theme (for projects created before October 20th 2020)

[mgeier]

See readthedocs/sphinx_rtd_theme#238, should be fixed by readthedocs/sphinx_rtd_theme#897.

AFAIK, other themes are not affected.

[mgeier]

I've just seen that there is a DONT_OVERWRITE_SPHINX_CONTEXT feature (https://read-the-docs.readthedocs.io/en/latest/guides/feature-flags.html), which would probably make it work.

It might have some unintended consequences, though.

[mgeier]

readthedocs/sphinx_rtd_theme#897 has been merged, now we just have to wait for a new release (https://github.com/readthedocs/sphinx_rtd_theme/releases).

[mgeier]

A new version of the RTD theme has been released in the meantime (hooray!), but RTD still seems to force sphinx-rtd-theme<0.5 by default ...

[mgeier]

I've asked why the new version of the RTD theme is not enabled by default: readthedocs/readthedocs.org#7858

[mgeier]

According to readthedocs/readthedocs.org#7858 (comment), the problem is solved for projects created after October 20th 2020, hooray!

Older projects will have to explicitly request a newer version.

One way seems to be to use the (undocumented) feature flag USE_SPHINX_LATEST (see https://docs.readthedocs.io/en/latest/guides/feature-flags.html).

Another way to get the new versions is to override the defaults by means of a requirements.txt file:

sphinx>=2
sphinx_rtd_theme>=0.5