Documentation

The PLINDER documentation resides in the docs directory. The documents are written in Markdown files rendered with Sphinx and MyST. The examples use Jupyter notebooks rendered with MyST-NB.

Building

Building the documentation requires some extra requirements that are specified in the pyproject.toml.

$ pip install -e ".[docs]"

To build the documentation run

$ sphinx-build docs <output directory>