Readthedocs.org: CSS format issue

Created on 15 Jun 2018  路  10Comments  路  Source: readthedocs/readthedocs.org

Details

A description of what you wanted to happen
Want the build to build like it normally does

Actual Result

A description of what actually happened

CSS looks to be broken.
http://docs.fusionpbx.com
http://docs.techlacom.com

Happens on both sites. Last build with no issue was Wednesday the 13th.

Support

Most helpful comment

Thank you for the help. I just moved the theme folder and ran a build and css is back. I really appreciate everyone's help!

All 10 comments

I think this is because of an update in theme, I'll try to see if I can reproduce this (also you can try to specify the latest version of the theme).

Where do I find the version of the theme and sphinx?

Where do I find the version of the theme and sphinx?

They will be in the build output.

Looks like it is using the latest version of the theme (0.4.0) with Sphinx 1.7.4.

Thanks for the tip @stsewd. So what happened is that:

  • The latest sphinx_rtd_theme is installed but not used because you have duplicated an old version of the theme into your project directory.
  • Older versions of the theme relied on Read the Docs always using the same CSS (bundled with readthedocs.org) rather than the CSS that is bundled with the theme. We changed this to allow the theme to be updated independently of Read the Docs. Previously, whether you were using the 0.2.5 theme or the 0.3.1 theme, you always got the same CSS.
  • So the version detection that checks whether to include the CSS finds the latest theme. However, your copied theme overrides the change to use the CSS bundled with the theme.

I see a couple solutions:

  • Remove most or all of the duplicated theme from your project and rebuild. Only override the bits you need. This is probably the best solution.
  • Pin to a previous version of the theme.

Theme has been the same since starting to use read the docs. I'm happy to do whatever needs done but trying to understand why this just happened this week with constant builds and after 2 years?

@Len-PGH that is explained above

Older versions of the theme relied on Read the Docs always using the same CSS (bundled with readthedocs.org) rather than the CSS that is bundled with the theme.

RTD update that in the latest deploy.

I see a couple solutions:

Another solution is to update your duplicated theme although I suspect you can just remove it.

trying to understand why this just happened this week

We made a change this week to increase the default version of the RTD theme used with Read the Docs. If there wasn't an overridden version of the theme in your project, this would have been transparent to you. The newest version of the theme bundles CSS a little differently and in the build process we detect the theme version to decide whether to Read the Docs should include some global CSS (the old, suboptimal way) or rely on the theme's CSS. This version detection failed on your project because it has the latest theme but you have overridden the theme with an old version that isn't installed.

Compare the layout of the theme duplicated in your project vs what is in the theme now. There are a number of improvements we made in the theme but those changes relied on upgrading the CSS independently of Read the Docs.

Thank you for the help. I just moved the theme folder and ran a build and css is back. I really appreciate everyone's help!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

enielse picture enielse  路  4Comments

lennartkoopmann picture lennartkoopmann  路  4Comments

cagataycali picture cagataycali  路  4Comments

adamjstewart picture adamjstewart  路  4Comments

gtalarico picture gtalarico  路  4Comments