#check #makefile #documentation #workflow #recipe #docstrings #testing

bin+lib mkhelp

Support for docstrings in makefiles

1 unstable release

0.2.3 Aug 22, 2024

#10 in #makefile

Download history 125/week @ 2024-08-21 16/week @ 2024-08-28 6/week @ 2024-09-04 47/week @ 2024-09-11 16/week @ 2024-09-18 15/week @ 2024-09-25 15/week @ 2024-10-02 51/week @ 2024-10-09

101 downloads per month

MIT license

9KB
228 lines

MkHelp

Support for docstrings in makefiles


Sometimes it is convenient to use a makefile as interface to development workflows. The recipes are flexible, can depend on other targets and make provides tab completion.

Once set up it could look something like

$ make
Verbs:
 help: Print help message

Checks:
    check_all: Run all checks that have not yet passed
 check_format: Check format
   check_lint: Check lint
   check_docs: Check that documentation can be built
  check_tests: Check that unit tests pass

Fixes:
 fix_format: Fix format
 fix_lint: Fix lint

Dependencies

~1.2–1.8MB
~33K SLoC