ThreeSixtyGiving / standard

The 360Giving data standard for UK philanthropic giving
http://www.threesixtygiving.org
Other
10 stars 15 forks source link

Upcoming Readthedocs changes #386

Open mrshll1001 opened 4 months ago

mrshll1001 commented 4 months ago

Read the docs are changing the way their builds work which means we need to make some changes in the repo. If we take no actions, builds will stop working in October.

They thankfully sent around an email detailing the changes we need to make, which basically amounts to ensuring we define html_baseurl ourselves inside of conf.py since they will stop defining it via injecting it.

I will spin up a branch and make the changes and test out building using the new config. Once confirmed working I will open up a PR.

I don't think this has any versioning implication for the standard, as it's doing some config for the docs build rather than editing documentation or schema.

mrshll1001 commented 4 months ago

I've created the branch and done the suggested edits. It appears to be building:

It took a refresh or two to get the CSS pulled through, for some reason, so don't panic if it looks different initially (I think).

All looks to be fine. Codelists, tables, and schema all look to be rendering ok.

The read the docs blog post says we can opt into the addons early to get ahead of the curve, but I can't see the option in the settings. I'll keep checking on it. Ideally we'd be able to enable the add-ons just for this branch of the docs to test everything works under the new environment. I'll wait a little while and see if it appears before opening up a PR.

neelima-j commented 1 month ago

@mrshll1001 Does this issue need any further action after PR 388 was merged?