Experiment adding a dynamic canonical URL to mkdocs

.readthedocs.yaml

@@ -13,6 +13,7 @@ version: 2
 
 mkdocs:
   configuration: mkdocs.yml
+  fail_on_warning: true
 
 # Optionally declare the Python requirements required to build your docs
 python:

mkdocs.yml

@@ -1,4 +1,17 @@
 site_name: Basic MkDocs Example Project
+
+# This setting is required for Canonical URLs.
+# You can read more about why you should consider using this:
+# https://docs.readthedocs.io/en/stable/canonical-urls.html
+#
+# Until https://github.com/readthedocs/readthedocs.org/issues/9781 is fixed,
+# you need to define CUSTOM_CANONICAL_URL yourself as a workaround.
+#
+# For instance, navigate to Admin => Environment and define
+# CUSTOM_CANONICAL_URL=https://SLUG.readthedocs.io/en/stable/
+# (don't expose it to PRs, they publish on different URLs)
+site_url: !ENV CUSTOM_CANONICAL_URL
+
 theme:
   name: readthedocs
   highlightjs: true