Populate html_context with READTHEDOCS_* environment variables (readthedocs#1581)

humitos · web-flow · commit cf898d3acc42 · 2024-08-01T19:18:37.000+02:00
* Populate `html_context` with `READTHEDOCS_*` environment variables Closes readthedocs#1578 * Typo
diff --git a/sphinx_rtd_theme/__init__.py b/sphinx_rtd_theme/__init__.py
@@ -4,6 +4,7 @@
 From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
 """
 
+import os
 from os import path
 from sys import version_info as python_version
 
@@ -36,6 +37,15 @@ def extend_html_context(app, pagename, templatename, context, doctree):
      # Add ``sphinx_version_info`` tuple for use in Jinja templates
      context['sphinx_version_info'] = sphinx_version
 
+     # Inject all the Read the Docs environment variables in the context:
+     # https://docs.readthedocs.io/en/stable/reference/environment-variables.html
+     context['READTHEDOCS'] = os.environ.get("READTHEDOCS", False) == "True"
+     if context['READTHEDOCS']:
+         for key, value in os.environ.items():
+             if key.startswith("READTHEDOCS_"):
+                 context[key] = value
+
+
 
 # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
 def setup(app):
