dev. notebook workflow

Kai Muehlbauer edited this page Apr 9, 2018 · 4 revisions

Notebook Workflow

Here is a short write-up of the new wradlib notebook workflow

  • All future examples, tutorials and code recipes will be written as jupyter notebooks. They are available in the dedicated repository wradlib-notebooks.

  • Within Travis-CI the notebooks are rendered and pushed to the branches devel or X.Y.Z (MAJOR.MINOR.PATCH). The rendering is done with the help of package nbconvert.

  • The rendering takes place while running the notebooks as unittest with testrunner using nbconvert API. Code coverage can be measured in the same process.

  • For incorporation into docs the rendered notebooks will be pulled in by wradlib-docs into the sources directory by Travis-CI. Developers should add the notebook in the toc of the respective rst-file. Sphinx-extension nbsphinx transforms the rendered notebook to the doc-html output.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.