-
Notifications
You must be signed in to change notification settings - Fork 17
Adding notebook support #99
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
Conversation
| "sphinx_rtd_theme==1.2.0", # Used to render documentation | ||
| "sphinx-autoapi==2.0.1", # Used to automatically generate api documentation | ||
| {% if preferred_linter == 'pylint' %} | ||
| {%- if preferred_linter == 'pylint' %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, that's nice. Thank you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+100
|
One slight change that I think is worth making here - I renamed the Also, I'm curious if you've had a chance to confirm that the pre-commit hook that will clear output from jupyter notebooks will pass the test immediately after hydrating a project from the template? I was running into an issue early on when I had a demo notebook where the pre-commit hook would find some small thing that had changed, and it would result in a failed pre-commit hook test for the very first commit. |
drewoldag
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks awesome. Thanks for putting it together!
| "sphinx_rtd_theme==1.2.0", # Used to render documentation | ||
| "sphinx-autoapi==2.0.1", # Used to automatically generate api documentation | ||
| {% if preferred_linter == 'pylint' %} | ||
| {%- if preferred_linter == 'pylint' %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+100
Nice catch, thank you!
I haven't, but I'll admit I now default to editing notebooks in plaintext if possible with how messy things get in RAIL. I'll take a look once I get this in. |
Adding a rendered notebooks option to the template.
Highlights include:
nb/directory into 'docs/' (I found it the best way for the .rst referencing to remain intuitive--I don't think this loses too much over having it sit next tosrc/, but if anyone has a better method I'm all ears)requirements.txtinto a jinja template to optionally include notebook dependenciesWill be followed shortly with some writing in the RTD documentation on notebooks. I'd also like to add conditioning to the CI (left an
if: ${{ true }}placeholder for now) to only install pandoc and other notebook requirements if option was selected, but this should be done in tandem with other CI changes I'm opening an issue for.