Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
dev. 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
X.Y.Z(MAJOR.MINOR.PATCH). The rendering is done with the help of package
The rendering takes place while running the notebooks as unittest with
nbconvertAPI. 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
sourcesdirectory by Travis-CI. Developers should add the notebook in the
tocof the respective rst-file. Sphinx-extension
nbsphinxtransforms the rendered notebook to the doc-html output.