wis2box documentation is developed using the Sphinx Python Documentation Generator using the reStructuredText format. Jupyter notebooks are also used for in-depth code examples.
To update the documentation, ensure that Sphinx, nbsphinx and Jupyter are installed on your system (hint:
run pip install -r requirements-dev.txt to install the dependencies). From here, make html will
build the documentation, which you can serve using any standard web server.
Some of the documentation is developed using Jupyter notebooks. To edit/update the Jupyter notebooks:
jupyter notebook
# browser should appearWhen saving Jupyter notebooks to version control, always ensure that they are fully rendered before committing (from the Jupyter menu, select Cell -> Run All).