Add readthedocs config file #276
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaeldiamant
approved these changes
Apr 14, 2022
There was a problem hiding this comment.
@jasonpaulos Thanks for catching!
I'll follow up out-of-band to understand how to better monitor the build.
A few thoughts:
- Reading the docs more closely, I see it specifies
.yamlextension. We previously defined.readthedocs.yml. Presumably the file extension explains the build failure. - I don't feel strongly about making the change in this PR, but it feels like we ought to delete
.readthedocs.yml. - Additionally,
.readthedocs.ymlexplicitly specifiespython.version: 3.10. From my read of the docs,build.os.tools_seems equivalent. Though it feels prudent to set both once the build works (or to make it work).
tzaffi
reviewed
Apr 14, 2022
tzaffi
approved these changes
Apr 14, 2022
michaeldiamant
approved these changes
Apr 14, 2022
|
Can this yaml file be copied over to the |
Likely yes |
algoidurovic
pushed a commit
to algoidurovic/pyteal
that referenced
this pull request
Apr 20, 2022
* Add readthedocs config file * Delete old config
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since merging #269, our readthedocs build has failed (as an example, see https://readthedocs.org/projects/pyteal/builds/16635690/), and I believe adding this configuration will properly tell it to use Python 3.10 to build our docs.
If this works, a similar thing will likely need to be added to the Python SDK following algorand/py-algorand-sdk#313 (cc @algochoi)