From cf56f9937a644bb6b64fb49bccf31854f3e6689c Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Tue, 11 Oct 2022 14:49:02 +0200 Subject: [PATCH 1/3] Revert "Update layout.html to support a sphinx version that is not three-integers (#1345)" This reverts commit 45cf21874fb005ac86206ed26f609cb509eebbb2. --- sphinx_rtd_theme/__init__.py | 9 --------- sphinx_rtd_theme/layout.html | 4 ++++ 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/sphinx_rtd_theme/__init__.py b/sphinx_rtd_theme/__init__.py index 9ea323f0c..f31909865 100644 --- a/sphinx_rtd_theme/__init__.py +++ b/sphinx_rtd_theme/__init__.py @@ -31,12 +31,6 @@ def config_initiated(app, config): _('The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.') ) - -def extend_html_context(app, pagename, templatename, context, doctree): - # Add ``sphinx_version_info`` tuple for use in Jinja templates - context['sphinx_version_info'] = sphinx_version - - # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package def setup(app): if python_version[0] < 3: @@ -66,7 +60,4 @@ def setup(app): else: app.config.html_add_permalinks = "\uf0c1" - # Extend the default context when rendering the templates. - app.connect("html-page-context", extend_html_context) - return {'parallel_read_safe': True, 'parallel_write_safe': True} diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index 99ec01b71..1d7011976 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -9,6 +9,10 @@ {%- 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, _ver_bugfix) = sphinx_version.split('.') | map('int') -%} +{%- set sphinx_version_info = (_ver_major, _ver_minor, _ver_bugfix) -%} + From a93bd83fa64ce8f6499adb55e7c21fb00c990c66 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Tue, 11 Oct 2022 14:50:19 +0200 Subject: [PATCH 2/3] Always slice list before unpacking so number of elements is expected range `map` filter returns a generator that needs to run through the `list` filter before slicing --- sphinx_rtd_theme/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index 1d7011976..8e19c39c1 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -10,7 +10,7 @@ {%- 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, _ver_bugfix) = sphinx_version.split('.') | map('int') -%} +{%- set (_ver_major, _ver_minor, _ver_bugfix) = (sphinx_version.split('.') | map('int') | list)[:3] -%} {%- set sphinx_version_info = (_ver_major, _ver_minor, _ver_bugfix) -%} From c7f5f742b2e714cd4f4974156625b255f7592a27 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 12 Oct 2022 11:47:45 +0200 Subject: [PATCH 3/3] Let's keep it a 3-tuple but always set 3rd component to -1 -- in case a project was unpacking 3 values --- docs/changelog.rst | 1 + sphinx_rtd_theme/layout.html | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 3215b4c2e..71d14c08e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -45,6 +45,7 @@ Minor changes * Python 3.10 added to test matrix (#1334) * Supplemental Docker setup for development (#1319) * Most of setup.py migrated to setup.cfg (#1116) +* Jinja2 context variable ``sphinx_version_info`` is now ``(major, minor, -1)``, the patch component is always ``-1``. Reason: It's complicated. (#1345) Incompatible Changes diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index 8e19c39c1..bb0c069a2 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -10,8 +10,8 @@ {%- 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, _ver_bugfix) = (sphinx_version.split('.') | map('int') | list)[:3] -%} -{%- set sphinx_version_info = (_ver_major, _ver_minor, _ver_bugfix) -%} +{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%} +{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%}