This repository contains tutorials for using Nix and Nixpkgs written as Jupyter notebooks. The tutorials
- can be read online
- or used interactively using Binder.
Warning: When working on these tutorials, please keep in mind that the notebooks are executed outside of a Nix build. Don't blindly evaluate them.
To open the development environment shell
nix-shell -A devEnv
To open Jupyterlab for writing tutorials
nix-shell -A devEnv --run "jupyter-lab"
To build the the run-time dependencies used by Binder
nix-build -A runDeps
To compose the documentation
nix-shell -A devEnv --run "make -C doc html"
When contributing a new tutorial
- add the tutorial add the correct place
- add a reference in
doc/reference.rst - add a code owner in
.github/CODEOWNERS