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 .readthedocs.yml to version 2 #318

Merged
merged 1 commit into from
Sep 8, 2023

Conversation

kiancross
Copy link
Collaborator

What is the problem that this PR addresses?

Fixes breaking documentation build.

Closes #317.

How did you solve it?

Updated .readthedocs.yml to version 2, which also allows Poetry to be used for dependency installation.

Checklist

  • I have read the Contributor's Guide.
  • I will check that all automated PR checks pass before the PR gets reviewed.

Updated `.readthedocs.yml` to version 2, which also allows Poetry to be
used for dependency installation.
@kiancross
Copy link
Collaborator Author

Somehow, this commit needs backporting to the 2.0.0 tag so that the 2.0.0 build is fixed on ReadTheDocs.

Since the 2.0.0 release, there have only been minor dependency updates (2.0.0...master), so it is probably safe to tag this commit with 2.0.0 after it is merged into master.

Alternatively, we could release 2.0.1 and hide 2.0.0 on ReadTheDocs.

Option 1 is quicker (and probably safe), whereas option 2 is certainly safe. @tmbo do you have any thoughts?

@kiancross kiancross requested a review from tmbo September 6, 2023 16:00
Copy link
Owner

@tmbo tmbo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@kiancross kiancross merged commit 4c54305 into tmbo:master Sep 8, 2023
30 checks passed
@kiancross kiancross deleted the fix-read-the-docs branch September 8, 2023 11:15
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.

Publish documentation of 2.0.0
2 participants