validations-libs/doc/source/index.rst
Gael Chamoulaud (Strider) e4b5dc3ea7 Add CLI auto generated documentation using Cliff
This patch adds the Cliff Sphinx Extension support for auto documenting
the `validation` Command Line Interface. It also standardizes the
`metavar` description for all the --group, --category and --product
arguments by using <group_id>, <category_id> and <product_id>.

Moreover, it removes usage example(s) in the arguments helpers which are often
duplicated with the `metavar`.

Change-Id: I3009337e8afadd705bbee5b89d9022c78093cdc8
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
2021-07-27 07:01:19 +00:00

440 B

Validations Framework Client API

This is the Validations Framework Client API. It provides:

  • a Python API: the validations_libs module, to
  • list and run validation(s) on node(s).

Contents

readme contributing testing cli reference/index

Indices and tables

  • genindex
  • search