conditionally load extension

Author: oraNod

docs/docsite/rst/conf.py

@@ -18,9 +18,10 @@
 
 import sys
 import os
+import tomllib
 from pathlib import Path
 
-import yaml
+from sphinx.application import Sphinx
 
 DOCS_ROOT_DIR = Path(__file__).parent.resolve()
 
@@ -70,7 +71,6 @@
     'notfound.extension',
     'sphinx_antsibull_ext',  # provides CSS for the plugin/module docs generated by antsibull
     'sphinx_copybutton',
-    'sphinx_reredirects', # redirects pages that have been restructured or removed
 ]
 
 # Later on, add 'sphinx.ext.viewcode' to the list if you want to have
@@ -393,12 +393,21 @@
 linkcheck_workers = 25
 # linkcheck_anchors = False
 
-# Generate redirects for pages that have been restructured or moved
-# if EXTRA_TAGS="-t redirects" is passed with the make invocation
-redirects = {}
-if tags.has('redirects'):
-    redirects_config_path = DOCS_ROOT_DIR.parent / "ansible_redirects.yaml"
-    redirect_keys = yaml.safe_load(
-      redirects_config_path.read_text(encoding="utf-8")
-    )
-    redirects = redirect_keys
+# Generate redirects for pages when building on Read The Docs
+def setup(app: Sphinx) -> dict[str, str]:
+
+    if tags.has('redirects'):
+
+        redirects = {}
+        redirects_config_path = DOCS_ROOT_DIR.parent / "ansible_redirects.toml"
+        with open(redirects_config_path, "rb") as f:
+            redirects = tomllib.load(f)
+
+        app.setup_extension('sphinx_reredirects') # redirect pages that have been restructured or removed
+        app.config.redirects = redirects
+
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+        "version": app.config.release,
+    }