Recent sphinx_rtd_theme 1.0.0 results in unstyled pages

[reece]

sphinx_rtd_theme 1.0.0 renders vrs docs without styling. 0.5.2 works correctly. Using sphinx 4.2.0.

git checkout main  # d684bab8f1a15
pip install sphinx_rtd_theme==1.0.0
make -C docs clean
make -C docs html
xdg-open docs/build/html/index.html

With that, I get Image [1]. When I pip install sphinx_rtd_theme==0.5.2, I get Image [2].

There are no errors on the console. Behavior is identical when serving the same pages with and without TLS (see below). Removing the custom theme_overrides.css had no effect.

The most straightforward explanation is that sphinx 4.2.0 + sphinx_rtd_theme 1.0.0 is not correctly generating styled pages. That seems unlikely.

Two consequences: 1) We can no longer view pages locally unless we use 0.5.2. 2) If the problem is with our config, our docs at RTD might break soon. That would be unfortunate.

# serving docs over http/https 
cargo install https
http docs/build/html/
http --gen-ssl docs/build/html/   # with a self-signed cert

Image [1]

Image [2]

[reece]

I have verified that sphinx + sphinx_rtd_theme generates files just fine when starting from scratch. So, there's something unique about our setup. I'll investigate.