summaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorTom Rini <trini@konsulko.com>2024-07-19 08:53:23 -0600
committerTom Rini <trini@konsulko.com>2024-07-19 08:53:23 -0600
commitcb0b7ab607aa71ae4b77a2b4d30d3d604c8324af (patch)
treedc3702be4e5ca6bdcf2ca66d4948bc44cf72a36a /doc/conf.py
parent459560000736ac7c9c8b04522789c20fb45ff95a (diff)
parent38b000881ebc0a48b0a814fce9f52dfe62ac644b (diff)
Merge tag 'efi-2024-10-rc1-3' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request efi-2024-10-rc1-3 Documentation: * Move out-of-tree building info to HTML * Enable ReadTheDocs addon management * Remove FIT documentation that is elsewhere * Update table of contents for FIT images * Add description for more boot methods UEFI: * Correct finding distro device-path for media devices * Fix typo in EFI_RT_VOLATILE_STORE description Other: * MAINTAINERS: Rename BOOTDEVICE
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py
index c9138a5a5d4..e79134cc3d7 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -21,6 +21,12 @@ from subprocess import check_output
# Get Sphinx version
major, minor, patch = sphinx.version_info[:3]
+# Set canonical URL from the Read the Docs Domain
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+# Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+ html_context["READTHEDOCS"] = True
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the