From b8a4d884aa6a6b570261178c7fc7856c2a097ab0 Mon Sep 17 00:00:00 2001
From: Benjamin Bach <benjamin@readthedocs.org>
Date: Wed, 11 Jan 2023 15:17:18 +0100
Subject: [PATCH 1/4] Respect that dirhtml builder does not have .html in
 canonical URLs

---
 sphinx_rtd_theme/layout.html | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html
index bb0c069a2..00705259c 100644
--- a/sphinx_rtd_theme/layout.html
+++ b/sphinx_rtd_theme/layout.html
@@ -51,12 +51,22 @@
 
   {#- CANONICAL URL (deprecated) #}
   {%- if theme_canonical_url and not pageurl %}
-    <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
+    <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}{% if builder == 'dirhtml' %}/{% else %}.html{% endif %}"/>
   {%- endif -%}
 
   {#- CANONICAL URL #}
+  {# NB! pageurl is currently a non-documented template context variable! #}
+  {# pageurl implementation: https://www.sphinx-doc.org/en/master/_modules/sphinx/builders/html.html #}
   {%- if pageurl %}
-    <link rel="canonical" href="{{ pageurl|e }}" />
+    {# pageurl implementation wrongly: adds .html for the dirhtml builder's pageurl #}
+    {# Workaround for: https://github.com/sphinx-doc/sphinx/issues/9730 #}
+    {# Once a fix is released in Sphinx, put an upper bound on the Sphinx version for the workaround #}
+    {% if builder == 'dirhtml' and pageurl.endswith('.html') %}
+      {# This expression trims away .html and adds a / #}
+      <link rel="canonical" href="{{ (pageurl|e)[:-5] }}/" />
+    {% else %}
+      <link rel="canonical" href="{{ pageurl|e }}" />
+    {% endif %}
   {%- endif -%}
 
   {#- JAVASCRIPTS #}

From a58a5870295af87b8ecccef3216fe8a167364cd7 Mon Sep 17 00:00:00 2001
From: Benjamin Bach <benjamin@readthedocs.org>
Date: Wed, 11 Jan 2023 15:52:46 +0100
Subject: [PATCH 2/4] Show build with dirhtml option enabled

---
 .readthedocs.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.readthedocs.yml b/.readthedocs.yml
index 21d235821..26a44dc41 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -9,3 +9,4 @@ python:
 
 sphinx:
   configuration: docs/conf.py
+  builder: dirhtml

From 9083bfc2305da817b8b7152394a9698f765d37bc Mon Sep 17 00:00:00 2001
From: Benjamin Bach <benjamin@readthedocs.org>
Date: Wed, 11 Jan 2023 16:24:08 +0100
Subject: [PATCH 3/4] Trim whitespaces around Jinja2 blocks

---
 sphinx_rtd_theme/layout.html | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html
index 00705259c..f612bd6be 100644
--- a/sphinx_rtd_theme/layout.html
+++ b/sphinx_rtd_theme/layout.html
@@ -54,19 +54,23 @@
     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}{% if builder == 'dirhtml' %}/{% else %}.html{% endif %}"/>
   {%- endif -%}
 
-  {#- CANONICAL URL #}
-  {# NB! pageurl is currently a non-documented template context variable! #}
-  {# pageurl implementation: https://www.sphinx-doc.org/en/master/_modules/sphinx/builders/html.html #}
-  {%- if pageurl %}
-    {# pageurl implementation wrongly: adds .html for the dirhtml builder's pageurl #}
-    {# Workaround for: https://github.com/sphinx-doc/sphinx/issues/9730 #}
-    {# Once a fix is released in Sphinx, put an upper bound on the Sphinx version for the workaround #}
-    {% if builder == 'dirhtml' and pageurl.endswith('.html') %}
-      {# This expression trims away .html and adds a / #}
+  {#-
+    CANONICAL URL
+    NB! pageurl is currently a non-documented template context variable!
+    pageurl implementation: https://www.sphinx-doc.org/en/master/_modules/sphinx/builders/html.html
+  -#}
+  {%- if pageurl -%}
+    {#-
+      pageurl implementation wrongly: adds .html for the dirhtml builder's pageurl
+      Workaround for: https://github.com/sphinx-doc/sphinx/issues/9730
+      Once a fix is released in Sphinx, put an upper bound on the Sphinx version for the workaround
+    -#}
+    {%- if builder == 'dirhtml' and pageurl.endswith('.html') -%}
+      {#- This expression trims away .html and adds a / -#}
       <link rel="canonical" href="{{ (pageurl|e)[:-5] }}/" />
-    {% else %}
+    {%- else -%}
       <link rel="canonical" href="{{ pageurl|e }}" />
-    {% endif %}
+    {%- endif -%}
   {%- endif -%}
 
   {#- JAVASCRIPTS #}

From df87a40d0a9c7799231b51ae24399b7499d75ec4 Mon Sep 17 00:00:00 2001
From: Benjamin Bach <benjamin@readthedocs.org>
Date: Wed, 11 Jan 2023 16:36:27 +0100
Subject: [PATCH 4/4] Trimmed a bit too many whitespaces

---
 sphinx_rtd_theme/layout.html | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html
index f612bd6be..9b00d0320 100644
--- a/sphinx_rtd_theme/layout.html
+++ b/sphinx_rtd_theme/layout.html
@@ -65,10 +65,10 @@
       Workaround for: https://github.com/sphinx-doc/sphinx/issues/9730
       Once a fix is released in Sphinx, put an upper bound on the Sphinx version for the workaround
     -#}
-    {%- if builder == 'dirhtml' and pageurl.endswith('.html') -%}
-      {#- This expression trims away .html and adds a / -#}
+    {%- if builder == 'dirhtml' and pageurl.endswith('.html') %}
+      {#- This expression trims away .html and adds a / #}
       <link rel="canonical" href="{{ (pageurl|e)[:-5] }}/" />
-    {%- else -%}
+    {%- else %}
       <link rel="canonical" href="{{ pageurl|e }}" />
     {%- endif -%}
   {%- endif -%}