Skip to content

Commit 17aadb7

Browse files
rhc54hppritcha
authored andcommitted
Read The Docs updates
RTD is rolling out some changes. Per https://about.readthedocs.com/blog/2024/07/addons-by-default/, these are the changes we need to make. Port of open-mpi/ompi#12687 Signed-off-by: Ralph Castain <rhc@pmix.org> (from upstream commit 584845f)
1 parent 41014c1 commit 17aadb7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,15 @@
8686
if key in os.environ and os.environ[key] == 'True':
8787
print("PRRTE: found ReadTheDocs build environment")
8888

89+
# Tell Jinja2 templates the build is running on Read the Docs
90+
if "html_context" not in globals():
91+
html_context = {}
92+
html_context["READTHEDOCS"] = True
93+
94+
# Define the canonical URL if you are using a custom domain on
95+
# Read the Docs
96+
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
97+
8998
rtd_v = os.environ['READTHEDOCS_VERSION']
9099
if os.environ['READTHEDOCS_VERSION_TYPE'] == 'external':
91100
# Make "release" be shorter than the full "prte_ver" value.

0 commit comments

Comments
 (0)