Skip to content

Commit 7abb0f3

Browse files
committed
explain how we use nbval, and where we save notebook output
1 parent 2697a86 commit 7abb0f3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

book/info.org

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
* <2022-01-05 Wed 07:42> Notes on nbval:
2+
3+
** Chapters with matplotlib output
4+
- for chapter 15 (matplotlib) [and other with matplotlib], we run into fails if svg+xml output is saved
5+
- For some of the fails, I have created entries in [file:static/nbvas_sanitize.cfg] to ignore the changes (and commented out)
6+
- Update on closer inspection: in the past, we didn't save the output, and thus the problem never occurred.
7+
- But what does nbval do if the cells are empty, and it computes output?
8+
- if we do not save output, then nbval will not complain about the empty cells
9+
- if an exception occurs, it will report a fail.
10+
- So --nbval on empty output cells behaves like --nbval-lax on saved output
11+
- So not saving the output might be the right way, as jupyter-book executes the
12+
notebooks anyway when computing pdf and html
13+
(And that's what we did before my recent changes, I just had to remind myself ...)
14+
15+
** Extra treatment of Chapter 18 Environments
16+
- should not execute automatically (because the description of creating
17+
virtual envs is tailored to running it on a mac with Anaconda).
18+
- achieved via instruction in [file:_config.yml]
19+
- should be skipped by nbval for same reasons (use --ignore switch for that)

0 commit comments

Comments
 (0)