Skip to content

Remove Sphinx<5 compatibility leftovers #1512

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.

Sign up for GitHub

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

Merged
merged 16 commits into from
Jan 3, 2024
Merged

Remove Sphinx<5 compatibility leftovers #1512

Changes from 6 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
3afbed2
Remove Sphinx<5 compatibility
humitos Aug 23, 2023
c48c630
Always use `writer-html5`
humitos Aug 23, 2023
d4a06c0
Use `css_tag` helper to inject CSS files
humitos Aug 23, 2023
2ab5fe8
Revert "Remove Sphinx<5 compatibility"
humitos Aug 23, 2023
d4a06b0
Set `data-content_root` for Sphinx >= 7.2
humitos Aug 23, 2023
27f1033
Default value for `DISPLAY` and `--new-tab`
humitos Aug 23, 2023
a8d888d
Visual test with Firefox and tox
humitos Aug 23, 2023
be3900c
Update sphinx_rtd_theme/layout.html
humitos Aug 28, 2023
d17787a
Merge branch 'master' into humitos/sphinx-compatibility
humitos Aug 29, 2023
ecec5c8
Merge branch 'humitos/sphinx-compatibility' of github.com:readthedocs…
humitos Nov 30, 2023
f6a9e5b
Remove code from merge conflict
humitos Nov 30, 2023
f1fa48e
Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into…
humitos Nov 30, 2023
408e756
Revert a mistake done on merging
humitos Nov 30, 2023
16e0621
Update CSS logic again
humitos Jan 2, 2024
fe03f04
Minor refactor to undocumented `extra_css_files` option
humitos Jan 2, 2024
6ca6e35
Merge branch 'master' into humitos/sphinx-compatibility
humitos Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 9 additions & 43 deletions sphinx_rtd_theme/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@
{%- set titlesuffix = "" %}
{%- endif %}
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' -%}

{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #}
{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%}
{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%}

<!DOCTYPE html>
<html class="{{ sphinx_writer }}" lang="{{ lang_attr }}" >
<html class="writer-html5" lang="{{ lang_attr }}"{% if sphinx_version_info >= (7, 2) %} data-content_root="{{ content_root }}"{% endif %}>
<head>
<meta charset="utf-8" />
{{- metatags }}
Expand All @@ -24,29 +23,17 @@
{%- endblock -%}

{#- CSS #}
{%- if sphinx_version_info < (4, 0) -%}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- endif %}
{%- for css in css_files %}
{%- if css|attr("rel") %}
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
{%- else %}
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
{%- endif %}
{{ css_tag(css) }}
{%- endfor %}

{%- for cssfile in extra_css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{{ css_tag(cssfile) }}
{%- endfor -%}

{#- FAVICON
favicon_url is the only context var necessary since Sphinx 4.
In Sphinx<4, we use favicon but need to prepend path info.
#}
{%- set _favicon_url = favicon_url | default(pathto('_static/' + (favicon or ""), 1)) %}
{%- if favicon_url or favicon %}
<link rel="shortcut icon" href="{{ _favicon_url }}"/>
{#- FAVICON #}
{%- if favicon_url %}
<link rel="shortcut icon" href="{{ favicon_url }}"/>
{%- endif %}

{#- CANONICAL URL (deprecated) #}
Expand All @@ -65,30 +52,9 @@
<script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
<![endif]-->
{%- if not embedded %}
{# 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 #}
{%- if sphinx_version_info >= (1, 8) -%}
{%- if sphinx_version_info < (4, 0) -%}
<script id="documentation_options" data-url_root="{{ url_root }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
{%- endif -%}
{%- for scriptfile in script_files %}
{{ js_tag(scriptfile) }}
{%- endfor %}
{%- else %}
<script>
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'{{ url_root }}',
VERSION:'{{ release|e }}',
LANGUAGE:'{{ language }}',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }},
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
};
</script>
{%- for scriptfile in script_files %}
<script src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{%- endif %}
{%- for scriptfile in script_files %}
{{ js_tag(scriptfile) }}
{%- endfor %}
<script src="{{ pathto('_static/js/theme.js', 1) }}"></script>

{#- OPENSEARCH #}
Expand Down