Notes for developers#
Testing#
Please add relevant tests to test/
. To run all tests:
mkdir build/
cmake .. -DBUILD_TESTS=ON
./test/test
Building the docs#
To set-up build dependencies consider using Conda
conda env update --file environment_docs.yaml
Then,
cd docs
doxygen
make html
Note
By default the latest version of the Python API on conda-forge is used, this may results in outdated docs. If you want the latests docs, please build and install the Python module first, see install_python_source.