Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: heed RTD admonition regarding the deprecation of html_base_url #4627

Merged
merged 3 commits into from
Sep 19, 2024
Merged

doc: heed RTD admonition regarding the deprecation of html_base_url #4627

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4a9dd2
Heed RTD admonition regarding the deprecation of html_base_url.
jiceatscion Sep 19, 2024
2aa3c17
Remove change advised by RTD but not applicable to us.
jiceatscion Sep 19, 2024
6429646
Restore the change regarding html_context (but correctly this time).
jiceatscion Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import subprocess
import os

# -- Project information -----------------------------------------------------

Expand All @@ -14,6 +15,14 @@

# -- General configuration ---------------------------------------------------

# 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
html_context = {}
if os.environ.get("READTHEDOCS", "") == "True":
html_context["READTHEDOCS"] = True

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
Expand Down
Loading