docs: Add canonical link to html pages (#314)

ValerianRey · web-flow · commit d5b802f249aa · 2025-04-18T12:40:17.000+02:00
* Add _templates/page.html with extrahead block containing canonical link
* Add templates_path to conf.py
diff --git a/docs/source/_templates/page.html b/docs/source/_templates/page.html
@@ -0,0 +1,16 @@
+{#
+    Adds a canonical link to the stable version of the documentation to each built hmtl page.
+    The reason to do that is that search engines require it:
+    https://developers.google.com/search/docs/crawling-indexing/consolidate-duplicate-urls
+
+    This template overrides the page.html furo template
+    (https://github.com/pradyunsg/furo/blob/main/src/furo/theme/furo/page.html) by adding an extra
+    line to its <head> section, with the appropriate canonical link. Note that there is no guarantee
+    that the furo theme keeps using a file named page.html, so this could silently break with future
+    updates of furo. See https://pradyunsg.me/furo/customisation/injecting/ and
+    https://github.com/pradyunsg/furo/discussions/248 for more information.
+#}
+{% extends "!page.html" %}
+{% block extrahead %}
+    <link rel="canonical" href="https://torchjd.org/stable/{{ pagename }}.html">
+{% endblock %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -44,6 +44,7 @@
 
 html_theme = "furo"
 html_static_path = ["_static"]
+templates_path = ["_templates"]
 
 autodoc_member_order = "bysource"
 intersphinx_mapping = {
