From 06c973588846e38b1b4890d2ac2ff1eb1aa3dd67 Mon Sep 17 00:00:00 2001 From: "Ed (ODSC)" Date: Thu, 29 Aug 2024 15:50:42 +0100 Subject: [PATCH] documentation/conf.py: New RTD config requirements --- documentation/conf.py | 11 +++++++++++ requirements.txt | 1 + 2 files changed, 12 insertions(+) diff --git a/documentation/conf.py b/documentation/conf.py index 0801bee2..f640910e 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -27,6 +27,17 @@ from recommonmark.transform import AutoStructify from recommonmark.parser import CommonMarkParser +# -- Read the Docs -------------------------------------------------------- + +# 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 + # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. diff --git a/requirements.txt b/requirements.txt index 19b36a11..58f11787 100644 --- a/requirements.txt +++ b/requirements.txt @@ -29,3 +29,4 @@ jsonref==0.1 lxml==4.9.1 openpyxl==3.0.10 schema==0.4.0 +setuptools==65.5.0