Skip to content

Comments

Rough draft of notebooks for discussion#1

Merged
mikofski merged 2 commits intomikofski:masterfrom
kandersolar:first_draft
Jan 30, 2021
Merged

Rough draft of notebooks for discussion#1
mikofski merged 2 commits intomikofski:masterfrom
kandersolar:first_draft

Conversation

@kandersolar
Copy link
Collaborator

@mikofski @shirubana - here are some starting notebooks for discussion. I more or less followed the bullets in our google doc, except I didn't do one for AC-side modeling. Is this kind of along the lines of what you were thinking, or am I barking up a different tree?

Side note, we might think about building a little sphinx website for the notebooks; GitHub's notebook viewer is always really buggy for me. One way to do that might be like what I'm doing in this RdTools PR, generating a gallery from notebooks: NatLabRockies/rdtools#240

@mikofski
Copy link
Owner

Thanks for getting a jump start on these! I like the idea about a sphinx site. Also we should demonstrate to folks, perhaps in a readme how to start these with binder - for after the tutorial, during the tutorial I suggest we stick with tljh. As far as GH slow/faulty rendering of Jupyter notebooks, I usually point folks to the nbviewer online since it works so much better.

I promise I will take a look at these after Thanksgiving and before the winter break.

@kandersolar
Copy link
Collaborator Author

Also we should demonstrate to folks, perhaps in a readme how to start these with binder

Some projects include "Open this notebook on Binder" links at the top of sphinx pages, for example: https://nbsphinx.readthedocs.io/en/0.4.1/installation.html
I think sphinx-gallery can do that automatically, but because we're using notebooks maybe we should just do it the way nbsphinx's docs do it: https://github.com/spatialaudio/nbsphinx/blob/0.4.1/doc/conf.py#L54-L76

I promise I will take a look at these after Thanksgiving and before the winter break.

Of course, no rush! Thanks!

@kandersolar
Copy link
Collaborator Author

There is also the sphinx-book-theme: https://sphinx-book-theme.readthedocs.io/en/latest/launch.html

@mikofski mikofski merged commit 855aaab into mikofski:master Jan 30, 2021
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.

3 participants