Skip to content

Commit 1f7bdc1

Browse files
authored
sphinx_rtd_theme/layout: Set url_root properly on index, don't use '#' (#1025)
- You can see a practical demonstration of the problem, fully seeing the effect if it is not fixed, here (though that example uses the alabaster theme, the effect is the same here): executablebooks/sphinx-copybutton#110 - This is a copy of a fix from Sphinx. The sphinx pull request is sphinx-doc/sphinx#8524 Detailed description: - url_root is set to `#` on the index page, which layout.html tries to change back to `''` (the empty string). - But, this updated url_root wasn't used in the actual location, as an argument to `documentation_options.js`. - Thus, clever enough templates, which tried to use `$DOCUMENTATION_OPTIONS.URL_ROOT` inside javascript would fail. This was manifested as broken links, which led to this issue: executablebooks/sphinx-copybutton#110 - I have eventually traced that back to sphinx itself, and found that layout.html tried to fix the problem, but the fixed value wasn't used. - This fix works in my basic test, but I will continue with more tests. - Review: - someone more clever should examine this and make sure it makes sense - This does not have tests. Should it?
1 parent e93295c commit 1f7bdc1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

sphinx_rtd_theme/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
{%- if not embedded %}
5858
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
5959
{% if sphinx_version >= "1.8.0" %}
60-
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
60+
<script type="text/javascript" id="documentation_options" data-url_root="{{ url_root }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
6161
{%- for scriptfile in script_files %}
6262
{{ js_tag(scriptfile) }}
6363
{%- endfor %}

0 commit comments

Comments
 (0)