Makefile
********

This makefile contains targets for

* accomplishing tasks (:ref:`Verbs`) and
* creating artifacts (:ref:`Nouns`).

Verbs
=====
This section contains targets that

* May have side effect
* Should not have side effects should not affect nouns

.. _makefile.help:

:code:`help`
  Print help message

Checks
------

.. _makefile.check_all:

:code:`check_all`
  Run all checks that have not yet passed

.. _makefile.check_format:

:code:`check_format`
  Check format

.. _makefile.check_lint:

:code:`check_lint`
  Check lint

.. _makefile.check_dist:

:code:`check_dist`
  Check that distribution can be built and will render correctly on PyPi

.. _makefile.check_docs:

:code:`check_docs`
  Check that documentation can be built

.. _makefile.check_diff:

:code:`check_diff`
  Check that there are no untracked git changes

.. _makefile.check_tests:

:code:`check_tests`
  Check that unit tests pass

.. _makefile.check_tox:

:code:`check_tox`
  Check that unit tests pass in multiple environments

.. _makefile.check_types:

:code:`check_types`
  Check types

Fixes
-----

.. _makefile.fix_format:

:code:`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

.. _makefile.bin/print_makefile_help.py:

:code:`bin/print_makefile_help.py`
  Update the script that generates the help message for this makefile

.. _makefile.build/docs/index.html:

:code:`build/docs/index.html`
  Build this documentation
  
  If it runs slow, try removing the :code:`CLEAN_DIR_TARGET` line in the recipe.