Makefile.help

# venv
pip_install_tools       install requirements-pkg.txt into site-packages
pip_install_dev         install requirements-dev.txt into site-packages
pip_install_lint        install requirements-lint.txt into site-packages
pip_install_build       install requirements-build.txt into site-packages
pip_install_docs        install docs/requirements.txt into site-packages
pipenv_init             build a venv using pipenv
pipenv_clean            remove the venv built by pipenv

# docs
docs                    run docs/make html and rebuild ALL docs
docs_dev                run docs/make html and only rebuild changed docs
docs_coverage           run docs/make coverage
docs_linkcheck          run docs/make linkcheck
docs_open               open the html docs in a browser
docs_apigen             install the latest version of sphinx into tmp folder and run
                        sphinx-apidoc with custom templates to generate the API reference
                        docs
docs_dumprefs           dump all of the sphinx targets found in objects.inv

# git fun
git_check               check that the repo is clean and a tag exists for current version
git_tag                 make a tag for current version and push it

# packaging
pkg_build               make clean, make pipenv_install_build, build the package
pkg_publish             make lint, make pkg_build, make git_check, publish the package to pypi

# testing
lint                    run isort, black, pydocstyle, flake8, and bandit
cov_open                open the test coverage html docs in a browser

# clean up
clean_tests             clean up test folders/files
clean_files             clean up a bunch of files
clean_docs              make pipenv_install_docs, run docs/make clean
clean_pkg               clean up build folders/files
clean                   make clean_files, make clean_pkg, make clean_tests,
                        make clean_docs, make pipenv_clean

# other
help                    this...

# call me first
init                    make pip_install_tools, make clean, make py_env,
                        make pipenv_init, make pipenv_install_*