Fix links in readthedocs to stable version #416
Merged
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.
Reference Issues/PRs
#386
What does this implement/fix? Explain your changes.
In our docs, binder button on top of notebooks should point to correct version since we're now using versioned docs. On master, binder link in README should point to master branch and build based on master.
Wasn't sure how to best solve this, options included:
postBuild
file,Dockerfile
,For now I've added a
Dockerfile
.postBuild
would have required to move all binder related config files from the.binder/
folder into the root directory. Setting up nightly builds and wheel storage requires much more work.This seems to solve most links, except the link of the binder launch button on the README.rst which will still point to master even if you're viewing the documentation for one of the stable versions on readthedocs.
Comments
Speeding up build can be achieved by building the docker image separately in a GitHub Action: see this post, this GitHub Action and this example