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

Steps for html version of tutorial #97

Open
hugobowne opened this issue Oct 29, 2020 · 2 comments
Open

Steps for html version of tutorial #97

hugobowne opened this issue Oct 29, 2020 · 2 comments

Comments

@hugobowne
Copy link
Collaborator

hugobowne commented Oct 29, 2020

@ericmjl Today we discussed steps for an html version of tutorial:

  • add notebooks to subdir of /docs
  • make sure they execute programmatically: can do this manually by making sure all cells execute in order; can you remind me of how to automate this step?
  • Travis will build and create github pages

Did I get that mostly correct?


Update from @ericmjl:

  • Place custom source code in src/bayes_tutorial/<something_appropriate>.py. Then import it back into the notebook.
  • Use the matplotlibrc file that @hugobowne provided to style all of the plots.
  • We should probably put this in a "style guide" documentation.
@ericmjl
Copy link
Owner

ericmjl commented Oct 29, 2020

@hugobowne yep, that's right!

can do this manually by making sure all cells execute in order; can you remind me of how to automate this step?

Use nbconvert to programmatically execute the notebooks. Ideally they should execute fast, to keep build times short.

@ericmjl
Copy link
Owner

ericmjl commented Nov 11, 2020

@hugobowne I updated your comment with further details, so we both have a reference in this issue right at the top of the thread.

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

2 participants