Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to readthedocs config file #508

Merged
merged 2 commits into from
Dec 13, 2023
Merged

Update to readthedocs config file #508

merged 2 commits into from
Dec 13, 2023

Conversation

kd-ods
Copy link
Collaborator

@kd-ods kd-ods commented Dec 12, 2023

Overview

  • What does this pull request do?

Updates the ReadTheDocs config file in line with the platform's new requirements.

  • How can a reviewer test or examine your changes?

Eyeball the config file. (I've kept the python version at 3.9, not taken it to 3.11 as is in the RTD template. Is that ok?)

Verify that the build of this kd-od-rtd-update branch can be built on RTD (and still builds locally).

  • Who is best placed to review it?

@rhiaro or @radix0000

(Closes/Relates to) issue: #507

Translations

Documentation & Release

If we ever want to be able to rebuild the docs for older release branches, then we need to backport this update. @rhiaro or @radix0000 will need to advise on this.

@kd-ods
Copy link
Collaborator Author

kd-ods commented Dec 12, 2023

I've built this branch successfully on RTD: https://standard.openownership.org/en/kd-ods-rtd-update/schema/guidance/repr-trusts.html

(And it's still building locally as expected.)

@kd-ods kd-ods marked this pull request as ready for review December 12, 2023 13:11
@kd-ods kd-ods self-assigned this Dec 12, 2023
@kd-ods kd-ods requested a review from rhiaro December 12, 2023 13:11
@kd-ods
Copy link
Collaborator Author

kd-ods commented Dec 12, 2023

@rhiaro - please can you review this? See my questions re the python version, and re backporting.

@rhiaro
Copy link
Collaborator

rhiaro commented Dec 12, 2023

If we ever want to be able to rebuild the docs for older release branches, then we need to backport this update. @rhiaro or @radix0000 will need to advise on this.

I'd suggest we cross that bridge if we come to it! (Happy to hear other opinions, though.)

@kd-ods kd-ods merged commit 2965daf into main Dec 13, 2023
2 checks passed
@kd-ods kd-ods deleted the kd-ods-rtd-update branch December 13, 2023 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants