Respect that dirhtml builder does not have .html in canonical URLs

readthedocs · Jan 11, 2023 · 0978285 · 0978285
1 parent ce20cfc
commit 0978285
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html
@@ -51,12 +51,21 @@
 
   {#- 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 on the dirhtml builder #}
+    {# 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' %}
+      <link rel="canonical" href="{{ pageurl|e|trim(".html") }}" />
+    {% else %}
+      <link rel="canonical" href="{{ pageurl|e }}" />
+    {% endif %}
   {%- endif -%}
 
   {#- JAVASCRIPTS #}