Return the docstrings for all renderers. Optionally, specify a renderer or a function to narrow the selection. The strings are aggregated into a single document on the master for easy reading. Multiple renderers can be specified. .. versionadded:: 2015.5.0 CLI Exampl
(*args)
| 272 | |
| 273 | |
| 274 | def renderer_doc(*args): |
| 275 | """ |
| 276 | Return the docstrings for all renderers. Optionally, specify a renderer or a |
| 277 | function to narrow the selection. |
| 278 | |
| 279 | The strings are aggregated into a single document on the master for easy |
| 280 | reading. |
| 281 | |
| 282 | Multiple renderers can be specified. |
| 283 | |
| 284 | .. versionadded:: 2015.5.0 |
| 285 | |
| 286 | CLI Example: |
| 287 | |
| 288 | .. code-block:: bash |
| 289 | |
| 290 | salt '*' sys.renderer_doc |
| 291 | salt '*' sys.renderer_doc cheetah |
| 292 | salt '*' sys.renderer_doc jinja json |
| 293 | |
| 294 | Renderer names can be specified as globs. |
| 295 | |
| 296 | .. code-block:: bash |
| 297 | |
| 298 | salt '*' sys.renderer_doc 'c*' 'j*' |
| 299 | |
| 300 | """ |
| 301 | renderers_ = salt.loader.render(__opts__, []) |
| 302 | docs = {} |
| 303 | if not args: |
| 304 | for func in renderers_.keys(): |
| 305 | docs[func] = renderers_[func].__doc__ |
| 306 | return salt.utils.doc.strip_rst(docs) |
| 307 | |
| 308 | for module in args: |
| 309 | if "*" in module or "." in module: |
| 310 | for func in fnmatch.filter(renderers_, module): |
| 311 | docs[func] = renderers_[func].__doc__ |
| 312 | else: |
| 313 | moduledot = module + "." |
| 314 | for func in renderers_.keys(): |
| 315 | if func.startswith(moduledot): |
| 316 | docs[func] = renderers_[func].__doc__ |
| 317 | return salt.utils.doc.strip_rst(docs) |
| 318 | |
| 319 | |
| 320 | def list_functions(*args, **kwargs): # pylint: disable=unused-argument |