Developer information#

This page contains the necessary information to contribute to this package.

Contributing guide#

The guide for contributors is in the repository: vnmabus/dcor.

Building the documentation#

In order to build the documentation, please first install the necessary packages listed in readthedocs-requirements.txt:

pip install -r readthedocs-requirements.txt

The documentation and its configuration is stored in the docs subfolder. In order to build the documentation using Sphinx, execute the following commands in that folder:

make clean
make html

Code of conduct#

The code of conduct for contributors is in the repository: vnmabus/dcor