Skip to content

Commit

Permalink
Update configuration for ReadTheDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
dpvc committed Sep 3, 2024
1 parent 6e0ed5c commit e0a5033
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@

import sys, os

### DPVC -- from https://about.readthedocs.com/blog/2024/07/addons-by-default/
# Define the canonical URL if you are using a custom domain on Read the Docs
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":
if "html_context" not in globals():
html_context = {}
html_context["READTHEDOCS"] = True
### /DPVC

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand Down

0 comments on commit e0a5033

Please sign in to comment.