22.25.1.3. salt.runners.doc

A runner module to collect and display the inline documentation from the various module types

salt.runners.doc.execution()

Collect all the sys.doc output from each minion and return the aggregate

CLI Example:

salt-run doc.execution
salt.runners.doc.runner()

Return all inline documentation for runner modules

CLI Example:

salt-run doc.runner
salt.runners.doc.wheel()

Return all inline documentation for wheel modules

CLI Example:

salt-run doc.wheel

Docs for previous releases are available on salt.rtfd.org.

Latest Salt release: 2014.7.1

Previous topic

22.25.1.2. salt.runners.cloud

Next topic

22.25.1.4. salt.runners.error

SaltStack News

Upcoming SaltStack events, webinars and local meet ups and user groups.