Usage

This project is divided into several Makefiles, connected by a root Makefile which redirects commands whever necessary.

Root Recipes

PY

A string that contains the command used for your Python interpreter. Defaults to python3.

help

Prints the recipes found in all subfolders.

clean

Removes all temporary or cache files, as well as any build artifacts.

html

dirhtml

singlehtml

epub

latex

These recipes redirect to the docs Makefile. Note that this is a multi-target recipe that includes many of the builder names supported by Sphinx.

c_%

Recipes with this prefix are redirected to the C directory. Please see language-specific documentation for more details.

cp_%

Recipes with this prefix are redirected to the C++ directory. Please see language-specific documentation for more details.

cs_%

Recipes with this prefix are redirected to the C# directory. Please see language-specific documentation for more details.

docs_%

Recipes with this prefix are redirected to the docs directory.

js_%

Recipes with this prefix are redirected to the JavaScript directory. Please see language-specific documentation for more details.

py_%

Recipes with this prefix are redirected to the Python directory. Please see language-specific documentation for more details.

rs_%

Recipes with this prefix are redirected to the Rust directory. Please see language-specific documentation for more details.

%

If the recipe you call isn't covered by any others, it will get distributed to all languages. So for instance, make test would be translated to make c_test cp_test cs_test js_test py_test rs_test

Universal Recipes

The recipes in this section are supported by every language.

help

Prints the recipes found in a given folder.

test

test_auto

test_%

These recipes will run through the test routine of whichever language they are called for. If called with no suffix, tests will be run in a single thread. If called with the auto suffix, it will run using all or nearly all the of the CPUs on the machine. If called with an integer suffix, it will run tests in that number of threads. Note that while not all test runners support specifying a number of threads, the recipe is maintained in all languages for compatibility reasons.

clean

Removes all temporary or cache files, as well as any build artifacts.