Skip to content

Add documentation on running tests and building docs #1444

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

Closed
ColCarroll opened this issue Oct 12, 2016 · 3 comments
Closed

Add documentation on running tests and building docs #1444

ColCarroll opened this issue Oct 12, 2016 · 3 comments

Comments

@ColCarroll
Copy link
Member

Just want to comment here that I'm working on making sure example notebooks run smoothly. I'm not familiar with a best practice for notebooks in a repo -- let me know if there are specifics with how to run them before committing (i.e., should stderr be suppressed?)

@twiecki
Copy link
Member

twiecki commented Oct 13, 2016

What's your plan? I think it's definitely a good idea to use e.g. runipy in the standard test-suite that all NBs are not raising exceptions.

@ColCarroll
Copy link
Member Author

Haven't seen runipy before -- that definitely looks helpful. I don't think running all the examples would be good for the test suite -- haven't tried, but I'd guess running them serially would take ~2hrs. Perhaps just wrapping that functionality into a script?

It would be good to have a document (or add a section) with instructions on

  1. Setting up a dev environment
  2. Running the tests locally
  3. Generating the docs (this may include re-running notebooks, or maybe that's a separate step)

I'm not sure how to do #3, though.

@twiecki
Copy link
Member

twiecki commented Oct 14, 2016

I don't anticipate us re-running the NBs all that often so probably not worth productizing that. But certainly 1-3 would be useful documentation.

@twiecki twiecki changed the title Update example notebooks Add documentation on running tests and building docs Oct 14, 2016
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