many older doc versions have broken JS

[leos]

Details

• Read the Docs project URL: https://django-reversion.readthedocs.io/en/release-1.8/

Expected Result

Clicking on the version selector down in the bottom left should work. It should pop up a selector that lets me pick a version of the docs.

Actual Result

Clicking on it doesn't do anything and there's an error in the console:

(index):383 Uncaught ReferenceError: SphinxRtdTheme is not defined
    at HTMLDocument.<anonymous> ((index):383)
    at f (jquery-2.0.3.min.js:23)
    at Object.fireWith [as resolveWith] (jquery-2.0.3.min.js:23)
    at Function.ready (jquery-2.0.3.min.js:22)
    at HTMLDocument.dt (jquery-2.0.3.min.js:22)
(anonymous) @ (index):383
f @ jquery-2.0.3.min.js:23
fireWith @ jquery-2.0.3.min.js:23
ready @ jquery-2.0.3.min.js:22
dt @ jquery-2.0.3.min.js:22
readthedocs-doc-embed.js:1
Applying theme sidebar fix...

This appears to happen on old versions of docs for multiple projects that I tried. Happy to provide a few more if it's helpful. On https://django-reversion.readthedocs.io/en/latest/ the popup works correctly, but switching to one of the older versions breaks it.

[humitos]

Thanks for the report!

We have this chunk of JS embeded in the HTML:

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>

SphinxRtdTheme is defined in https://media.readthedocs.org/javascript/readthedocs-doc-embed.js --which is loaded by the page, but it seems it is loaded after this code is executed.

[stsewd]

This is coming from the theme https://github.com/readthedocs/sphinx_rtd_theme/blob/8a026194285971d25fa80d47bc1a703b4d67f60d/sphinx_rtd_theme/layout.html#L228-L232

but I don't see anything being loaded async or in the wrong order

  <script type="text/javascript" src="https://media.readthedocs.org/javascript/readthedocs-doc-embed.js"></script>
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>

The only thing that could have made this happen would be if window is undefined.... which would be weird, I think?

https://github.com/readthedocs/sphinx_rtd_theme/blob/8a026194285971d25fa80d47bc1a703b4d67f60d/src/theme.js#L227-L235

[stsewd]

The only thing that could have made this happen would be if window is undefined.... which would be weird, I think?

Looks like it's defined, so more like a race condition with the other part of the script being loaded before... but I don't understand how that would be possible with the current order

[astrojuanlu]

Found in other projects as well, for example https://neuropsydia.readthedocs.io/

[benjaoming]

Another example: https://django-tenant-schemas.readthedocs.io/

It's weird. When the jQuery block is executed, SphinxRtdTheme is not defined and it fails. After loading the document, SphinxRtdTheme is defined. But calling SphinxRtdTheme.StickyNav.enable() doesn't make the Flyout menu work.

[kuzmoyev]

Similar issue with the search page (e.x. gcsa with

Uncaught ReferenceError: jQuery is not defined
    at search.html?q=SendUpdatesMode&check_keywords=yes&area=default:291:7
search.html?q=SendUpdatesMode&check_keywords=yes&area=default:299 Uncaught ReferenceError: jQuery is not defined
    at search.html?q=SendUpdatesMode&check_keywords=yes&area=default:299:5

)

[benjaoming]

@kuzmoyev thanks for adding feedback here - this project is broken because it uses Sphinx 6.x and hasn't upgraded to sphinx-rtd-theme 1.2.0. If you can contribute a fix to them, that'd be great 👍

[kuzmoyev]

Thanks for the info. I'm the owner of the project. I don't have a cap on the sphinx and sphinx-rtd-theme versions, but for some reason, the last build was with sphinx-rtd-theme=0.5.1. Hitting rebuild resolved the issue

[benjaoming]

@kuzmoyev haha, that makes it very easy for you to contribute to the project 💯 thanks for confirming that it works, I guess the former build from last week happened exactly before sphinx-rtd-theme 1.2.0 was released.

[spacemanspiff2007]

I'm experiencing the same issue for sml2mqtt when building with sphinx_rtd_theme 1.2.0 and sphinx 6.1.3

[benjaoming]

Hi @spacemanspiff2007 - thanks for reporting. Looking at your build configuration, I didn't find anything problematic.

In the HTML output[1], it appears that jquery.js has been included as the last file instead of the first. This is opposite behavior from before. I'll have to look into why that has happened.

[1] view-source:https://sml2mqtt.readthedocs.io/en/rework/index.html

edit: next time, I'll take a screenshot :) Now jQuery is gone from the output html. That's a much better explanation of what is going on. Will investigate, as the problem doesn't seem to exist in other builds.

[spacemanspiff2007]

The last build from ~14 days ago worked fine so it seems there was something introduced in that time frame.