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

Fix links in readthedocs to stable version #416

Merged
merged 9 commits into from Oct 19, 2020
Merged

Conversation

mloning
Copy link
Contributor

@mloning mloning commented Oct 5, 2020

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:

  • using a postBuild file,
  • using a Dockerfile,
  • installing from nightly builds (see e.g. scikit-learn)

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

  • reset settings to always run notebooks in conf.py, here disabled for faster debugging

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

@mloning mloning added documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution labels Oct 5, 2020
@mloning mloning marked this pull request as draft October 5, 2020 15:07
@mloning mloning marked this pull request as ready for review October 14, 2020 15:45
@mloning mloning merged commit 528ec52 into master Oct 19, 2020
@mloning mloning deleted the readthedocs-binder branch October 19, 2020 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant