Examples

Here is the list of the example projects that show how to use taskutils with the Nimble script. The list is sorted by increasing complexity.

`custom_task`

A library project where the Nimble script has one custom task called docs to generate the API documentation.

Same as previously, but the output directory of the generated API doc can be customized by setting the environment variable OUTDIR:

OUTDIR="$PWD/apidocs" nimble docs

An error will be raised, if OUTDIR is set to an empty or blank (ASCII) string. If it is not set, it will default to $PWD/htmldocs.

An example project with 2 tasks and 2 distinct environment variables, where one of them is used by both tasks.

Compiles and runs any .nim files in tests/.

Name	Expected Value	Default value	Description
`OUTDIR`	A non empty or blank path.	`$PWD/.nimblecache/docs/`	The directory where to put the files generated by the compiler.
`NIM_BACKEND`	One of the following: `c`, `cxx`, `objc`, `js`	`c`	The backend to compile the tests with.

Generates the project documentation.

Name	Expected Value	Default value	Description
`OUTDIR`	A non empty or blank path.	`$PWD/.nimblecache/docs/`	The directory where to put the files generated by the compiler.