Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTMLZip output shouldn't include/point to online resources #2637

Open
agjohnson opened this issue Feb 9, 2017 · 7 comments
Open

HTMLZip output shouldn't include/point to online resources #2637

agjohnson opened this issue Feb 9, 2017 · 7 comments
Labels
Bug A bug Needed: design decision A core team decision is required

Comments

@agjohnson
Copy link
Contributor

Console log report from a user:

Failed to load resource: net::ERR_FILE_NOT_FOUND
readthedocs-dynamic-include.js Failed to load resource: net::ERR_FILE_NOT_FOUND
index.html:53 Uncaught ReferenceError: READTHEDOCS_DATA is not defined
at index.html:53
index.html:4608 Uncaught ReferenceError: SphinxRtdTheme is not defined
at HTMLDocument.<anonymous> (index.html:4608)
at j (jquery.js:2)
at Object.fireWith [as resolveWith] (jquery.js:2)
at Function.ready (jquery.js:2)
at HTMLDocument.J (jquery.js:2)
@agjohnson agjohnson added the Bug A bug label Feb 9, 2017
@ianbarker253
Copy link

This issue is also effecting us. All of the HTMLZip files for all versions the Search functionality is broken. I saw the above error and when ever someone executes a search the 'search.html' is not found.

@stsewd
Copy link
Member

stsewd commented Jun 1, 2018

Also, the version selector is broken, the data.js file is missing (I think this is injected only in the main html build process)

@stsewd
Copy link
Member

stsewd commented Aug 24, 2018

Related to #4452

@stsewd
Copy link
Member

stsewd commented Jan 8, 2019

So, I think we could edit the builders to not use the readthedocs builder, but only html builder when building the downloable docs, since they aren't used online anyway.

@stsewd stsewd added the Needed: design decision A core team decision is required label Jan 10, 2019
@stsewd
Copy link
Member

stsewd commented Feb 27, 2019

Actually search shouldn't be shown here, we provide singlethml versions of the docs to download. See #5359. But this is still relevant because we are including links to online resources

Like #2637 (comment)

@stsewd stsewd changed the title HTMLZip output search is broken HTMLZip output shouldn't include/point to online resources Feb 27, 2019
@stsewd
Copy link
Member

stsewd commented Mar 27, 2019

readthedocs/readthedocs-sphinx-ext#63 will remove the online resources, but we are going to still see the footer with some dummy/invalid links. The only thing I see is removing this from the theme https://github.com/rtfd/sphinx_rtd_theme/blob/ddfdd35e6977f21fb1771734732756b0cf1d6bba/sphinx_rtd_theme/versions.html#L1

@humitos
Copy link
Member

humitos commented Feb 1, 2023

@stsewd maybe that line you linked in the theme could check for something like:

{% if READTHEDOCS and app.builder.name != "singlehtml" %}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

4 participants