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

where should we be storing notebooks? #628

Closed
ctb opened this issue Jan 12, 2019 · 3 comments
Closed

where should we be storing notebooks? #628

ctb opened this issue Jan 12, 2019 · 3 comments

Comments

@ctb
Copy link
Contributor

ctb commented Jan 12, 2019

ref #430 - update notebooks for 2.0 release - some thoughts.

the overall goal of the notebooks is to provide some nice executable examples of things people want to do. I'd like to make sure they work on binder as well.

should the notebooks live in this repo?

reasons for including notebooks in this repo:

  • everything in one place!
  • could run tests on 'em
  • good guidance for devs
  • version locked! (no trouble tracking versions between core code and notebook code)

reasons for not including the notebooks in this repo:

  • they will need to rely on a fairly large set of files, if we do anything real. (but we could download on the fly, too)
  • every change to the repo would result in the binder being rebuilt, generally unnecessarily...

organization

one suggestion from the Twitter was to use jupyter-book to organize a collection of notebooks.

maybe a solution?

start in this repo; if we accumulate a substantial collection of good notebooks we could split them into a book (in a separate repo) and ones that belong in this repo.

@ctb
Copy link
Contributor Author

ctb commented Jan 13, 2019

see also https://twitter.com/westurner/status/1084128522833219586 - nbsphinx will render executed & saved notebooks, so should work on readthedocs!

@ctb
Copy link
Contributor Author

ctb commented Feb 17, 2019

also see https://twitter.com/choldgraf/status/1097190243407515648, suggestion to try out sphinx-gallery!

@ctb
Copy link
Contributor Author

ctb commented Mar 9, 2019

with #631, we now have a few notebooks. yay! I'll close this issue for now.

@ctb ctb closed this as completed Mar 9, 2019
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

No branches or pull requests

1 participant