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

© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/runners/all/salt.runners.doc.html