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

Try on binder #1181

Merged
merged 8 commits into from
Nov 27, 2020
Merged

Try on binder #1181

merged 8 commits into from
Nov 27, 2020

Conversation

renefritze
Copy link
Member

This PR adds a sphinx extension that exposes a new directive to include a binder badge link to a branch in the pymor/docs repo where the generated tutorial notebooks live.

Example

Open for suggestions on badge link positioning and text.

@github-actions github-actions bot added the infrastructure Buildsystem, packages and CI label Nov 24, 2020
@renefritze renefritze added the pr:new-feature Introduces a new feature label Nov 24, 2020
@renefritze renefritze added this to the 2020.2 milestone Nov 24, 2020
@renefritze renefritze linked an issue Nov 24, 2020 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Nov 24, 2020

Codecov Report

Merging #1181 (6be6d6d) into master (39a3c20) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted Files Coverage Δ
src/pymor/bindings/fenics.py 84.30% <0.00%> (-0.80%) ⬇️
src/pymor/vectorarrays/list.py 83.40% <0.00%> (+0.40%) ⬆️

@renefritze renefritze self-assigned this Nov 25, 2020
@renefritze renefritze marked this pull request as draft November 25, 2020 09:07
@renefritze
Copy link
Member Author

renefritze commented Nov 25, 2020

Have a look @pymor/all
screenshot-docs pymor org-2020 11 25-13_10_33

Fixes for the v-align of the badge welcome.

TODO:

  • notebooks are read-only on binder
  • outputs don't preload
  • fix typo in note: make -> may

Integrating the download notebook links I will defer.

@sdrave
Copy link
Member

sdrave commented Nov 27, 2020

Have a look @pymor/all

Very nice! Maybe remove the 'Click here' as there is already the launch button?

@renefritze
Copy link
Member Author

Have a look @pymor/all

Very nice! Maybe remove the 'Click here' as there is already the launch button?

I've intentionally made both a link in case people do not think to click the badge

@renefritze
Copy link
Member Author

renefritze commented Nov 27, 2020

With the latest commit the remaining issues are fixed and this is now ready to merge.

@renefritze renefritze marked this pull request as ready for review November 27, 2020 13:54
@renefritze renefritze merged commit 5a17cca into master Nov 27, 2020
@renefritze renefritze deleted the try_on_binder branch November 27, 2020 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Buildsystem, packages and CI pr:new-feature Introduces a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add automatic "try-on-binder" links in tutorials
2 participants