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

improve example notebooks in docs #265

Merged
merged 71 commits into from
Jan 28, 2022
Merged

improve example notebooks in docs #265

merged 71 commits into from
Jan 28, 2022

Conversation

JessicaS11
Copy link
Member

Per the discussion in #196, now that the example notebooks are rendered on the docs page, we wanted them to be in their own section and the section headings needed to be made consistent. This PR largely addresses #257 and adds #264.

@github-actions
Copy link

github-actions bot commented Jan 24, 2022

Binder 👈 Launch a binder notebook on this branch for commit dcae8fe

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 447d243

Binder 👈 Launch a binder notebook on this branch for commit e12eb73

Binder 👈 Launch a binder notebook on this branch for commit c884967

Binder 👈 Launch a binder notebook on this branch for commit ab16f5c

Binder 👈 Launch a binder notebook on this branch for commit 3e5c2e5

Binder 👈 Launch a binder notebook on this branch for commit 68d7036

Binder 👈 Launch a binder notebook on this branch for commit ad24045

Binder 👈 Launch a binder notebook on this branch for commit 3e7e120

Binder 👈 Launch a binder notebook on this branch for commit 97c19c3

Binder 👈 Launch a binder notebook on this branch for commit 593f409

Binder 👈 Launch a binder notebook on this branch for commit d42dc08

Binder 👈 Launch a binder notebook on this branch for commit f3b1025

Binder 👈 Launch a binder notebook on this branch for commit e061fca

Binder 👈 Launch a binder notebook on this branch for commit 968935d

Binder 👈 Launch a binder notebook on this branch for commit aef9860

Binder 👈 Launch a binder notebook on this branch for commit 260cdae

Binder 👈 Launch a binder notebook on this branch for commit 990c3ba

Binder 👈 Launch a binder notebook on this branch for commit a648259

@JessicaS11 JessicaS11 requested a review from weiji14 January 25, 2022 16:28
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Great work @JessicaS11, this looks really neat! Makes it really easy for the user to walk through icepyx's functionality 😁

In terms of suggestions, I'm wondering if there's a way to get an automatic download link to the Jupyter notebook? I found executablebooks/MyST-NB#124 but wasn't sure how to activate it, maybe some configuration/plugin in Sphinx or MyST that can do the trick?

README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
Co-authored-by: Wei Ji <[email protected]>
@JessicaS11
Copy link
Member Author

In terms of suggestions, I'm wondering if there's a way to get an automatic download link to the Jupyter notebook? I found executablebooks/MyST-NB#124 but wasn't sure how to activate it, maybe some configuration/plugin in Sphinx or MyST that can do the trick?

That's a great idea! I'll look into it more.

@JessicaS11
Copy link
Member Author

It turns out the directive is available in the jupyter-sphinx extension, but the docs are outdated enough that they have the wrong roles listed. I found an example using it (see the footnote), and have since figured out that it does need the .ipynb extension. Filed an issue here.

@JessicaS11 JessicaS11 requested a review from weiji14 January 26, 2022 20:21
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

It turns out the directive is available in the jupyter-sphinx extension, but the docs are outdated enough that they have the wrong roles listed. I found an example using it (see the footnote), and have since figured out that it does need the .ipynb extension. Filed an issue here.

Good work tracking this down! I always find Sphinx plugins/configs hard to track down, they seem all over the place 😆

@JessicaS11
Copy link
Member Author

Good work tracking this down! I always find Sphinx plugins/configs hard to track down, they seem all over the place 😆

Thanks - and I agree! Though it turns out what I'd actually done was stumble upon the undocumented MyST-NB role (and for some reason Sphinx couldn't find the jupyter-sphinx ones - which are documented and current - even when I'd installed the extension).

@JessicaS11 JessicaS11 merged commit 86392c0 into development Jan 28, 2022
@JessicaS11 JessicaS11 deleted the clean-ex branch January 28, 2022 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants