documentation/conf.py: New RTD config requirements #388
Conversation
| 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": |
There was a problem hiding this comment.
Is there a particular reason to check for the value True rather than just check that a value is set? Usually we don't need such precision as being exactly the value "True" for something that only needs to be truthy
suggestion:
if os.environ.get("READTHEDOCS"):
# stuffThere was a problem hiding this comment.
This is taken verbatim from RTD's suggested config updates.
There was a problem hiding this comment.
(But I agree the suggestion is cleaner)
| @@ -29,3 +29,4 @@ jsonref==0.1 | |||
| lxml==4.9.1 | |||
| openpyxl==3.0.10 | |||
| schema==0.4.0 | |||
| setuptools==65.5.0 | |||
There was a problem hiding this comment.
This may have been auto added, we don't normally bundle the core python libraries setuptools here as it is python version specific. Suggest removing this from the commit.
There was a problem hiding this comment.
I think this was actually added deliberately, as the builds were previously failing due to setuptools not being included in the rtd build environment anymore.
This adds the fix to ensure that the readthedocs builds continue building. Build linked below: