diff options
| author | Quentin Young <qlyoung@qlyoung.net> | 2024-08-21 19:38:09 -0400 |
|---|---|---|
| committer | Quentin Young <qlyoung@qlyoung.net> | 2024-08-21 19:38:51 -0400 |
| commit | 95d9bf12e303ccf80659f4cd1e19dbcce902f0bf (patch) | |
| tree | fd4d445f7c500c27b5e92ee0db7b408b684d7b54 /doc/developer/conf.py | |
| parent | e2d63567eca53a437e503278e68601878d7bdd3c (diff) | |
doc: update sphinx configs for RTD changes
Read The Docs made some changes that require us to add some
configuration in our build config files.
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
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 495c604ae0..d158ded721 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -66,6 +66,13 @@ version = u"?.?" # The full version, including alpha/beta/rc tags. release = u"?.?-?" +# 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. |