Changes to conf.py in preparation for RTD Addons rollout

tethysplatform / tethys

The Tethys Platform main Django website project repository.

http://tethysplatform.org/

BSD 2-Clause "Simplified" License

92 stars 49 forks source link

Changes to conf.py in preparation for RTD Addons rollout #1070

Closed swainn closed 1 month ago

swainn commented 1 month ago

Description

Update conf.py per RTD's recommendations. See: https://about.readthedocs.com/blog/2024/07/addons-by-default/

Changes Made to Code:

Get html_baseurl from READTHEDOCS_CANONICAL_URL environment variable.
Add READTHEDOCS to the html_context.

Quality Checks

[x] New code is 100% tested
[x] Code has been formated
[x] Code has been linted
[x] Docstrings for new methods have been added

coveralls commented 1 month ago

coverage: 99.936%. remained the same when pulling c08853c71742d57d2f1fd220fbcfc4ffa8fe2eb0 on rtd-addons into 77b621d573acbcaa630f30a1d4c263b67892213d on main.