Contributing

Developer documentation for this repository.

installing

Python dependencies are managed through poetry.

git clone https://github.com/knotsanimation/knots-hub.git
cd knots-hub
poetry install --all-extras

documentation

Building the static documentation.

• make sure you have the doc extras dependencies installed.

• execute build-doc.py

You can also use the serve-doc.py for auto-building when you edit a source file (doesn’t work for autodoc and source code).

tests

Running the unittests.

• make sure you have the test extras dependencies installed.

• python -m pytest ./tests