Readthedocs.org: sphinx_rtd_theme has no syntax highlighting on readthedocs.io

[omani]

Details

• Read the Docs project URL: https://triggerfs.io/en/latest/install.html#manual
• Build URL (if applicable):
• Read the Docs username (if applicable):

Expected Result

Code syntax highlighting the same way I see it on my local machine when building the docs with sphinx-build.

Actual Result

No code syntax highlighting. This is also the case for other readthedocs.io sites which have the rdt_theme enabled.

My guess is that it only happens on the rtd theme. Any hints?

[omani]

also the official theme websitehas no highlighting, as well: http://sphinx-rtd-theme.readthedocs.io/en/latest/demo/demo.html#code-blocks

[davidfischer]

Syntax highlighting was added to the theme recently https://github.com/rtfd/sphinx_rtd_theme/pull/448. However, this version isn't yet the default version on Read the Docs. We are working through a few issues with upgrading the theme and we hope to have this as the default version in a few weeks.

In the meantime, you can pin the version to sphinx_rtd_theme>=0.3.1 to get syntax highlighting.

[omani]

yes pinning worked for me. thank you.

feel free to close or keep it open for users to see.

[PoslavskySV]

Thanks for solution, it works for me too, but I have also to add

.highlight {
    background: #ffffff !important;
}

in my style.css to make the background white again.

[ax3l]

Huh, @Blendify I think the changed background of highlighted text should be part of the rtd theme style.
After https://github.com/rtfd/sphinx_rtd_theme/pull/448 was merged, the highlighted text background is now green and keeping it consistent with the rtd theme background would make sense.

edit: @PoslavskySV oh wait are you using pygments_style = 'sphinx'? pygments_style = 'default' should be fine.

[Blendify]

The default style set by the theme is default however I think for older projects sphinx set the default to sphinx and would always override the theme. I do not think this is the case anymore though.

[amit1rrr]

In the meantime, you can pin the version to sphinx_rtd_theme>=0.3.1 to get syntax highlighting.

I am new to RTD and Sphinx. I had to figure out how to do this. If you are in the same boat, I documented the steps in this thread:
https://github.com/rtfd/readthedocs.org/issues/4072

[davidfischer]

I'm going to re-open this until https://github.com/rtfd/readthedocs.org/pull/4096 is fixed.