Documentation¶

Documentation for sphinx-invoke can be found from Read The Docs.

Sphinx directive for invoke tasks¶

The package sphinx-invoke contains the Sphinx directive which produces the usage and help for the invoke task.

For example:

.. invoke::
     :module: module.path.to.tasks
     :prog: programname

Essentially produces sections for each task with the content:

programname -h taskname

Note

This directive supports only invoke==0.12.2.

The package can be installed with pip:

# pip install sphinx-invoke

The development and the testing follows the Common Robot Libraries development practices defined in crl-devutils.