Experiment adding a dynamic canonical URL to mkdocs

readthedocs-examples · Dec 7, 2022 · e9fecf4 · e9fecf4
1 parent 4621a97
commit e9fecf4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -11,8 +11,16 @@ version: 2
 #   tools:
 #     python: "3.10"
 
+# This pattern will be supported by a better environment variable, proposed
+# here: TBD
+build:
+  jobs:
+    pre_build:
+      - export "MKDOCS_SITE_URL=$READTHEDOCS_PROJECT"
+
 mkdocs:
   configuration: mkdocs.yml
+  fail_on_warning: true
 
 # Optionally declare the Python requirements required to build your docs
 python:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,5 @@
 site_name: Basic MkDocs Example Project
+site_url: !ENV MKDOCS_SITE_URL
 theme:
   name: readthedocs
   highlightjs: true