New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doesn't work out-of-the-box on https://readthedocs.org/ when using the sphinx_rtd_theme (for projects created before October 20th 2020) #1
Comments
I've just seen that there is a It might have some unintended consequences, though. |
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). |
A new version of the RTD theme has been released in the meantime (hooray!), but RTD still seems to force |
I've asked why the new version of the RTD theme is not enabled by default: readthedocs/readthedocs.org#7858 |
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 Another way to get the new versions is to override the defaults by means of a
|
FIX readthedocs uses an old version of sphinx for projects created before 2020: mgeier/sphinx-last-updated-by-git#1 So force a newer version.
FIX readthedocs uses an old version of sphinx for projects created before 2020: mgeier/sphinx-last-updated-by-git#1 So force a newer version.
FIX readthedocs uses an old version of sphinx for projects created before 2020: mgeier/sphinx-last-updated-by-git#1 So force a newer version.
readthedocs uses an old version of sphinx for projects created before 2020: mgeier/sphinx-last-updated-by-git#1 So force a newer version manually. Also install missing apt packages for dot and plantuml
readthedocs uses an old version of sphinx for projects created before 2020: mgeier/sphinx-last-updated-by-git#1 So force a newer version manually. Also install missing apt packages for dot and plantuml
I think other themes might be affected too, such as the PyData theme – I have not been able to make this work, neither locally nor on readthedocs (pybamm-team/PyBaMM#3089). @mgeier could you please help investigate this? Here is a link to the PR build and the build logs. I did bump up the However, I can see that other projects have been able to make this extension work with the same theme, maybe this is an issue with our configuration? It is almost similar to others' configurations – so I don't see any conflicts. Or, is it because they are newer projects unlike ours (i.e., post-October 2020) and we have to request the aforementioned feature flag(s) in this thread from readthedocs? |
This issue is specifically about If a similar thing also happens with other themes, this likely has different causes. Especially if it doesn't work locally either. |
See readthedocs/sphinx_rtd_theme#238, should be fixed by readthedocs/sphinx_rtd_theme#897.
AFAIK, other themes are not affected.
The text was updated successfully, but these errors were encountered: