dev. notebook workflow
-
All future examples, tutorials and code recipes will be written as jupyter notebooks.
-
Within Travis-CI the raw notebooks are converted to python scripts as well as rendered with output to be incorporated into the docs. The conversion and rendering is done with the help of package
nbconvert
. -
The rendering takes place while running the notebooks as unittest with
testrunner.py
usingnbconvert
API. Code coverage can be measured in the same process. -
For incorporation into docs the rendered notebook will be placed into the doc/sources directory by Travis-CI. Developers should add the notebook in the
toc
of the respective rst-file. Sphinx-extensionnbsphinx
transforms the rendered notebook to the doc-html output.
wradlib.org -- Documentation -- Forum