Using the Makefile

This project includes a Makefile that you can use to perform common tasks such as running tests and building documentation.

Targets

This section contains a brief description of the targets defined in the Makefile.

clean

Removes generated packages, documentation, temporary files, etc.

lint

Runs pylint against the project files.

test

Runs the unit tests.

quicktest

Runs the unit tests without performing pre-test validations (like linting).

docs

Builds the documentation for production.

Note

You can also build the documents directly, bypassing validations like linting and testing using Sphinx Makefile directly.

cd docs
make clean && make html
make latexpdf

answers

Performs a quick build of the documentation and open it in your browser.

package

Builds the package for publishing.

publish

Publishes the package to your repository.

build

Installs the current project locally so that you may run the command-line application.

venv

Creates a virtual environment.

install

Installs (or updates) project dependencies.

install_docs

Installs (or updates) documentation dependencies.

licenses

Generates a report of the projects dependencies and respective licenses.

Note

If project dependencies change, please update this documentation.