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

bin+lib mkhelp

Support for docstrings in makefiles

1 unstable release

0.2.3 Aug 22, 2024

#12 in #recipe

Download history 111/week @ 2024-08-19 24/week @ 2024-08-26 9/week @ 2024-09-02 14/week @ 2024-09-09 47/week @ 2024-09-16 13/week @ 2024-09-23 16/week @ 2024-09-30 53/week @ 2024-10-07 53/week @ 2024-10-14 48/week @ 2024-10-21 27/week @ 2024-10-28 28/week @ 2024-11-04 29/week @ 2024-11-11

133 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.1–1.7MB
~31K SLoC