Makefile

This makefile contains targets for

  • accomplishing tasks (Verbs) and

  • creating artifacts (Nouns).

Verbs

This section contains targets that

  • May have side effect

  • Should not have side effects should not affect nouns

help

Print help message

Checks

check_all

Run all checks that have not yet passed

check_format

Check format

check_lint

Check lint

check_dist

Check that distribution can be built and will render correctly on PyPi

check_docs

Check that documentation can be built

check_diff

Check that there are no untracked git changes

check_tests

Check that unit tests pass

check_tox

Check that unit tests pass in multiple environments

check_types

Check types

Fixes

fix_format

Fix format

Nouns

This section contains targets that

  • Should have no side effects

  • Must have no side effects on other nouns

  • Must not have any prerequisites that are verbs

  • Ordered first by specificity, second by name

bin/print_makefile_help.py

Update the script that generates the help message for this makefile

build/docs/index.html

Build this documentation

If it runs slow, try removing the CLEAN_DIR_TARGET line in the recipe.