search

openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
6 stars 56 forks source link

build: Deal with RTD Deprecation #539

Closed feanil closed 1 month ago

feanil commented 1 month ago

More info here: https://about.readthedocs.com/blog/2024/07/addons-by-default/

tl;dr RTD used to inject data into conf.py but it's going to stop doing that so we need to read RTD environment variables and pull in that data ourselves to not break builds.

sarina commented 1 month ago

After reading the blog post this makes sense to me. It sounds like we need to make this change anywhere docs are built, but we have a good amount of time to do it. I'm not clear on how to test if this fix works - it renders and looks right, is that enough?

feanil commented 1 month ago

Yea, the fact that it renders and links work on the PR build should be sufficient.