File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/runners/__pycache__/doc.cpython-310.pyc
o
�N�g� � @ sT d Z ddlZddlZddlZddlZddlmZ dd� Zdd� Z dd � Z
d
d� ZdS )z_
A runner module to collect and display the inline documentation from the
various module types
� N)�SaltClientErrorc C s dS )z
Always load
T� r r r �D/opt/saltstack/salt/lib/python3.10/site-packages/salt/runners/doc.py�__virtual__ s r c C � t j�t�} | �� }|S )z�
Return all inline documentation for runner modules
CLI Example:
.. code-block:: bash
salt-run doc.runner
)�salt�runnerZRunnerClient�__opts__�get_docs��client�retr r r r �
r c C r )z�
Return all inline documentation for wheel modules
CLI Example:
.. code-block:: bash
salt-run doc.wheel
)r �wheelZWheelr r
r r r r r $ r r c C s� i } t j�td ��V}z|jddtd d�D ]}|�� D ]}| �|� qqW n tyE } zt|� g W Y d}~W d � S d}~ww t j
�| d �� g�}t
t|��}|W d � S 1 scw Y dS )z�
Collect all the sys.doc output from each minion and return the aggregate
CLI Example:
.. code-block:: bash
salt-run doc.execution
Z conf_file�*zsys.doc�timeout)r Nr
)r r Zget_local_clientr Zcmd_iter�values�updater �print� itertools�chain�
from_iterable�items�dict�list)Zdocsr r
�v�exc�ir r r � execution3 s$
����$�r )�__doc__r Zsalt.clientr Zsalt.runnerZ
salt.wheelZsalt.exceptionsr r r r r r r r r �<module> s