The documentation is available at: https://flyvis.github.io/datamate/
Run the build docs script or follow the instructions below to build the documentation.
The documentation is built with mkdocs.
Only applies to making changes to the examples.
- Run all notebooks inplace:
export JUPYTER_CONFIG_DIR=$(mktemp -d) # to avoid conflicts with notebook version and extensions
for notebook in ../examples/*.ipynb; do
jupyter nbconvert --to notebook --execute "$notebook" --inplace
done- Convert notebooks:
jupyter nbconvert --to notebook ../examples/*.ipynb --output-dir docs/examples/ --TagRemovePreprocessor.remove_cell_tags hide- Clear all notebook outputs (optional):
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace ../examples/*.ipynbmkdocs serveSee mkdocs user guide for more details.
mkdocs gh-deployor optionally specify a remote repository:
mkdocs gh-deploy --remote <remote_name>