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.

Sign up for GitHub

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

Added README file with mybinder links to make the notebooks interactive. #215

Closed
wants to merge 12 commits into from
Closed

Added README file with mybinder links to make the notebooks interactive. #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
669f419
Create Readme.md
HarshithaPrabhuswamy Aug 30, 2024
d717aeb
Create requirements.txt
HarshithaPrabhuswamy Aug 30, 2024
385b652
Update Readme.md
HarshithaPrabhuswamy Aug 30, 2024
b461eab
Update Readme.md
HarshithaPrabhuswamy Aug 30, 2024
a00fd9b
Update Readme.md
HarshithaPrabhuswamy Aug 30, 2024
4f839da
Update Readme.md
HarshithaPrabhuswamy Aug 30, 2024
942105b
Update Readme.md
HarshithaPrabhuswamy Aug 30, 2024
c99b4ea
Update Readme.md
HarshithaPrabhuswamy Aug 30, 2024
71bde4f
Rename Readme.md to README.md
HarshithaPrabhuswamy Aug 30, 2024
f9513e8
Adjusted GitHub CI
HarshithaPrabhuswamy Dec 2, 2024
7518542
Read the docs build error update.
HarshithaPrabhuswamy Dec 2, 2024
32d5e78
Delete docs/notebooks/README.md
HarshithaPrabhuswamy Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,8 @@ jobs:
- name: Check links
run: |
python -m sphinx -W --keep-going ./docs/ ./docs/_build/linkcheck/ -b linkcheck

- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0 # Fetch all history for all branches and tags
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These lines have no effect. Pease first bring this branch up-to-date.

1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@
}

# -- Options for Included Jupyter Notebooks ----------------------------------
nbsphinx_allow_errors = True
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HarshithaPrabhuswamy I don't want to allow errors, please drop this line.


nbsphinx_execute = "always"

Expand Down
8 changes: 8 additions & 0 deletions docs/notebooks/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
matplotlib
IPython
conflowgen
os
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HarshithaPrabhuswamy os and datetime are default libraries that don't require installation. Please drop these lines.

datetime
pandas
itertools
numpy
Loading