Added README file with mybinder links to make the notebooks interactive. #215
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
Added mybinder link for analyses.ipynb
Added all the libraries/packages required for running the Jupyter notebooks.
Included mybinder links to all the notebooks.
1kastner
requested changes
Dec 6, 2024
| @@ -126,6 +126,7 @@ | |||
| } | |||
|
|
|||
| # -- Options for Included Jupyter Notebooks ---------------------------------- | |||
| nbsphinx_allow_errors = True | |||
There was a problem hiding this comment.
@HarshithaPrabhuswamy I don't want to allow errors, please drop this line.
| matplotlib | ||
| IPython | ||
| conflowgen | ||
| os |
There was a problem hiding this comment.
@HarshithaPrabhuswamy os and datetime are default libraries that don't require installation. Please drop these lines.
docs/notebooks/README.md
Outdated
| )](https://mybinder.org/v2/gh/HarshithaPrabhuswamy/conflowgen/main?labpath=docs%2Fnotebooks%2Finput_distributions.ipynb) | ||
|
|
||
| To launch previews.ipynb - [](https://mybinder.org/v2/gh/HarshithaPrabhuswamy/conflowgen/main?labpath=docs%2Fnotebooks%2Fpreviews.ipynb) |
There was a problem hiding this comment.
please integrate these links into the respective Jupyter notebooks. I don't want this to be a separate file.
When people visit https://conflowgen.readthedocs.io/en/latest/notebooks/first_steps.html, I want them to see the button to try out first_steps.ipynb. For the other notebooks, I expect to happen the same.
| - name: Checkout repository | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 0 # Fetch all history for all branches and tags |
There was a problem hiding this comment.
These lines have no effect. Pease first bring this branch up-to-date.
Deleting README.md file
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.
No description provided.