Stop injecting the theme CSS on the RTD theme #39
Conversation
readthedocs_ext/readthedocs.py
Outdated
|
|
||
| # After v0.3.0 of the sphinx theme, the theme CSS should not be injected | ||
| # This decouples the theme CSS (which is versioned independently) from readthedocs.org | ||
| if theme_css.endswith('sphinx_rtd_theme.css'): |
There was a problem hiding this comment.
I think it's safer to check if context['html_theme'] == 'sphinx_rtd_theme'. The current check does not work if app.builder.name == 'readthedocssinglehtmllocalmedia' (see line 60).
There was a problem hiding this comment.
Nothing is necessary with readthedocssinglehtmllocalmedia and this change purposely doesn't apply there. That builder doesn't use the theme CSS on media.readthedocs.org.
readthedocs_ext/readthedocs.py
Outdated
| if theme_css.endswith('sphinx_rtd_theme.css'): | ||
| try: | ||
| import sphinx_rtd_theme | ||
| inject_css = LooseVersion(sphinx_rtd_theme.__version__) <= LooseVersion('0.3.0') |
There was a problem hiding this comment.
Do we need to update the theme version here, or will this work with 0.3.0 and 0.3.1, and this logic can stay?
There was a problem hiding this comment.
Believe it depends on readthedocs/sphinx_rtd_theme#614 being released right?
There was a problem hiding this comment.
Believe it depends on readthedocs/sphinx_rtd_theme#614 being released right?
Correct so perhaps we should bump to 0.4.0.
|
I updated this PR to stop injecting the theme CSS starting at v0.4.0 of the them (which isn't released) |
This performs a version check on the Read the Docs theme and only injects the
theme.cssfor older versions of the theme. The goal here is to break the tight coupling between the bundled code on readthedocs.org and the theme.css. Previously, the theme did not include the CSS if it was being built on Read the Docs. With this change, the theme CSS can be updated independently of Read the Docs.Related to readthedocs/sphinx_rtd_theme#614 but that PR does not strictly require this one. Without this change, both CSS files (a local one and one from readthedocs.org) will be included on theme versions >0.3.0.