diff options
| author | Jafar Al-Gharaibeh <jafar@atcorp.com> | 2024-08-22 00:05:24 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-08-22 00:05:24 -0400 |
| commit | 72dfd5a6bfd0c4a77767d2e2d2d5712d1bc25218 (patch) | |
| tree | 3ce16ed5cf07b087b3dd06b1e04a5606cfc7b7cf /doc/developer/conf.py | |
| parent | 5989d1cf78e3849319445321ce2ce901e35b5717 (diff) | |
| parent | 95d9bf12e303ccf80659f4cd1e19dbcce902f0bf (diff) | |
Merge pull request #16619 from qlyoung/fix-rtd-build-sphinx-environment-injection
doc: update sphinx configs for RTD changes
Diffstat (limited to 'doc/developer/conf.py')
| -rw-r--r-- | doc/developer/conf.py | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 76dd1e4f28..634f4aa804 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -67,6 +67,13 @@ version = "?.?" # The full version, including alpha/beta/rc tags. release = "?.?-?" +# 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 + # ----------------------------------------------------------------------------- # Extract values from codebase for substitution into docs. |