Pattern for auto-loading extension (probably fixing elsewhere)

[benjaoming]

This isn't an issue in this extension, just want to flag it here for further input.

AFAICT, #14 added an option for configuration and thus JS injection happens on the event config-inited. But it turns out that calling app.setup_extension("sphinxcontrib.jquery") from themes stopped working since somehow it happens after config-inited is fired:

https://github.com/readthedocs/sphinx_rtd_theme/blob/ee64d37ac95fcfe7a1e53d7ab72e09704606261e/sphinx_rtd_theme/__init__.py#L56-L60

I'm thinking that the extension can just call add_js_files directly. But it'd be nice that the contract is clear so it doesn't break again.

[Fleyderer]

Problem

With these lines

from sphinxcontrib.jquery import add_js_files as jquery_add_js_files
jquery_add_js_files(app, app.config)

i am now getting error

ImportError: cannot import name 'add_js_files' from 'sphinxcontrib.jquery' (...my_folders...\venv\Lib\site-packages\sphinxcontrib\jquery.py)

And there is really no add_js_files in jquery.py, because for some reason my sphinxcontrib-jquery has version 2.0 instead of 4.+

Solution

If anyone ever gets the same error as me, just run pip install --upgrade sphinxcontrib-jquery

[benjaoming]

@Fleyderer thanks for sharing! Several people have experienced this - it's fixed here but not released: readthedocs/sphinx_rtd_theme#1446

[humitos]

@benjaoming can we make a simple patch release that includes this fix?

[benjaoming]

Yes, I'd be happy to do that 👍