-
Notifications
You must be signed in to change notification settings - Fork 35
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
Exclude extra header from offline builders #63
Exclude extra header from offline builders #63
Conversation
I'm not sure what this PR removes. "Downloads" header only or its content? The screenshot shows the "Downloads" header with no links. Also, it seems that we want to remove the "Versions" header and its content for the HTMLZip version since there is no another version for this format. |
That comes from the theme https://github.com/rtfd/sphinx_rtd_theme/blob/ddfdd35e6977f21fb1771734732756b0cf1d6bba/sphinx_rtd_theme/versions.html#L1 Nothing we can do about that from the extension. This removes the injected header Which points to some online resources and causes some errors in the js console. See readthedocs/readthedocs.org#2637 |
Seems reasonable 👍 |
Actually looking at the code, I don't fully understand this. Is there not a better test for this, like checking explicitly for htmlzip format? @stsewd |
Ignore me, I read it wrong :D |
This PR was out of date, it should be using the constant
|
I pushed up the proper variable name, and am testing locally |
@stsewd in testing now I'm getting |
Aaand, that's from the new Sphinx search extension -- it works without that :) |
Related to readthedocs/readthedocs.org#2637
We don't need to insert the extra header for offline docs.
I tested it locally, it works as expected. We are going to still see this footer
But all the links are dummy, and it's because we set the
READTHEDOCS
env variable, and we use that on the theme to put some dummy data before it gets replaced by the api response https://github.com/rtfd/sphinx_rtd_theme/blob/ddfdd35e6977f21fb1771734732756b0cf1d6bba/sphinx_rtd_theme/versions.html#L1