README.md

Documentation

The documentation is available at: https://jaxleyverse.github.io/jaxley/

Building the Documentation

You can build the docs locally by running the following command from this subfolder:

jupyter nbconvert --to markdown ../docs/tutorials/*.ipynb --output-dir docs/tutorial/
mkdocs serve

The docs can be updated to GitHub using:

jupyter nbconvert --to markdown ../docs/tutorials/*.ipynb --output-dir docs/tutorial/
mkdocs gh-deploy