Skip to content

petrieh/sphinx-invoke

 
 

Repository files navigation

https://travis-ci.org/nokia/sphinx-invoke.svg?branch=master

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.

Installation

The package can be installed with pip:

# pip install sphinx-invoke

Development practices

The development and the testing follows the Common Robot Libraries development practices defined in https://github.com/nokia/crl-devutils.

About

A sphinx extension for documenting invoke tasks

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%