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
Conflicting interpretation of READTHEDOCS #543
Comments
We can simply change this to like |
@ericholscher @agjohnson why does rtd do this? Why not just leave it up to the theme? The CSS file too. |
Why does RTD do what? |
Host theme CSS and JS files while projects still have there own in the
build static dir
…On Mon, Jan 15, 2018 at 9:39 PM, Eric Holscher ***@***.***> wrote:
Why does RTD do what?
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#543 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AOeua9ZC4VdX6yQPjzAkG4DupD0rOHw1ks5tLAvOgaJpZM4RfJp9>
.
--
Aaron Carlisle
Picture taker | Bit cruncher | Pixel pusher | Document writer |
Project administrator for the Blender 3D Documentation Project
|
We do this because our extension points to hosted versions of these resources, but locally the files are still required. I think we're just going to remove the default version list from this theme anyways, as it is causing problems with how we want to be using the theme. I'll chime in with our requirements on another issue. |
* add Lato and Roboto fonts * add custom_last option to footer * add favicons * add fa icons to nav_version * remove versions menu, place content elsewhere * add link to home * show both view and edit buttons to GitHub * move last_info from footer to header * move show_sphinx from footer to versions * move project home link from sidebar to breadcrumbs * remove display_version theme option * indent favicon links * move content from subdir sphinx_rtd_theme to root * remove gitignore * add README.md * justify text in paragraphs and list items (close #1) * add end dot to footer * add VERSIONING (readthedocs#543) * edit analytics block * rename rtd to btd
In
sphinx_rtd_theme/layout.html#L208-L210
,_static/js/theme.js
is includedif not READTHEDOCS
. At the same time,sphinx_rtd_theme/versions.html#L1-L36
is includedif READTHEDOCS
. As a result, the following settings inhtml_context
produce a valid "versions box/menu" in the bottom of the sidebar, but it is not expandable due to the missing js script:In order to fix it, each artifact needs to be edited so that
<script type="text/javascript" src="/js/theme.js"></script>
(or the corresponding path) is added.I'd suggest using a different envvar/mechanism in order to know whether the project is to be hosted on readthedocs.org, so that the "versions box/menu" is usable no matter what the host is.
The text was updated successfully, but these errors were encountered: