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

docs: Specify Read the Docs build OS #1258

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Sep 19, 2023

Description of proposed changes

Read the Docs will soon require the specification of a build OS in our configuration file [1] and have already started temporary enforcement of this requirement as a warning. This commit follows the example in the RTD docs for conda environments [2], adding a build block using the latest supported Ubuntu and mambaforge.

[1] https://blog.readthedocs.com/use-build-os-config/
[2] https://docs.readthedocs.io/en/stable/config-file/v2.html#conda

Related issue(s)

Checklist

@victorlin victorlin self-assigned this Sep 19, 2023
@vercel
Copy link

vercel bot commented Sep 19, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nextclade ✅ Ready (Inspect) Visit Preview Sep 20, 2023 5:47pm

@victorlin
Copy link
Member Author

image

RTD previews are disabled for this project. Is that intentional?

@ivan-aksamentov
Copy link
Member

@victorlin Danke!

RTD previews are disabled for this project. Is that intentional?

Absolutely no idea what this is :)

So far we are managing without them it seems, but if you think they can be beneficial - feel free to enable.

@victorlin
Copy link
Member Author

It's docs builds on every PR, as one of the "Checks". We have it on every other RTD project and it's been useful. I've turned it on for Nextclade!

Read the Docs will soon require the specification of a build OS in our configuration file [1] and have already started temporary enforcement of this requirement as a warning. This commit follows the example in the RTD docs for conda environments [2], adding a `build` block using the latest supported Ubuntu and mambaforge.

[1] https://blog.readthedocs.com/use-build-os-config/
[2] https://docs.readthedocs.io/en/stable/config-file/v2.html#conda

Co-authored-by: John Huddleston <[email protected]>
@victorlin victorlin force-pushed the victorlin/update-rtd-config branch from 84f9d6e to d1eaecc Compare September 20, 2023 17:39
@victorlin victorlin marked this pull request as ready for review September 20, 2023 17:43
@victorlin victorlin merged commit aaac7ce into master Sep 20, 2023
@victorlin victorlin deleted the victorlin/update-rtd-config branch September 20, 2023 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants