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

Automatically add binder link to tutorial notebooks when generating html documentation #285

Open
arthurvd opened this issue Jul 15, 2022 · 0 comments
Labels
type: ci/cd Changes needed in the CI/CD pipeline type: documentation Improvements or additions to documentation
Milestone

Comments

@arthurvd
Copy link
Member

What is the need for this task.
Under #250, the use of binder was made possible.
Under separate issues (e.g. #246) our tutorials are converted into Jupyter notebooks.
Now, we want that in the generated HTML documentation, a Binder link automatically appears at the top.

What is the task?
Consider the approach of
https://ericmjl.github.io/blog/2020/9/12/add-a-direct-binder-link-for-built-html-notebooks/
https://github.com/ericmjl/Network-Analysis-Made-Simple/blob/master/scripts/binderbuilder/insert_binder_link.py
to automate this.

@arthurvd arthurvd added this to the Release 0.4 milestone Jul 15, 2022
@arthurvd arthurvd added this to To do in HYDROLIB-core via automation Jul 15, 2022
@arthurvd arthurvd modified the milestones: Release 0.4, Release 0.5 Dec 16, 2022
@arthurvd arthurvd modified the milestones: Release 0.5, Release 1.0 Apr 4, 2023
@priscavdsluis priscavdsluis added type: documentation Improvements or additions to documentation type: ci/cd Changes needed in the CI/CD pipeline labels Apr 9, 2024
@rhutten rhutten removed this from To do in HYDROLIB-core Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: ci/cd Changes needed in the CI/CD pipeline type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants