Pedro Algarvio dfddc15569 Resolve paths passed directly with `--files` 4 years ago
..
README.md a5b9961f78 Lay the ground for `invoke` usage 4 years ago
__init__.py f6c2355f33 Add loader checks although not currently enforcing them 4 years ago
docs.py dfddc15569 Resolve paths passed directly with `--files` 4 years ago
loader.py f6c2355f33 Add loader checks although not currently enforcing them 4 years ago
utils.py 6a4703146c Replace `tests/unit/test_doc.py` with a pre-commit hook. 4 years ago

README.md

What is this directory?

This directory contains python scripts which should be called by invoke.

Instead of having several multi-purpose python scripts scatered through multiple paths in the salt code base, we will now concentrate them under an invoke task.

Calling Invoke

Invoke can be called in the following ways.

Installed system-wide

If invoke is installed system-wide, be sure you also have blessings installed if you want coloured output, although it's not a hard requirement.

inv docs.check

Using Nox

Since salt already uses nox, and nox manages virtual environments and respective requirements, calling invoke is as simple as:

nox -e invoke -- docs.check