Python get_docs Examples

Example #1

File: doc.py Project: doesitblend/salt

def runner(mod_name="*"):
    """
    Return all inline documentation for runner modules

    CLI Example:

    .. code-block:: bash

        salt-run doc.runner
    """
    client = salt.runner.RunnerClient(__opts__)
    if mod_name == "*":
        ret = client.get_docs()
    else:
        ret = client.get_docs(mod_name)
    return ret

Example #2

def wheel():
    '''
    Return all inline documentation for wheel modules
    '''
    client = salt.wheel.Wheel(__opts__)
    ret = client.get_docs()
    salt.output.display_output(ret, '', __opts__)
    return ret

Example #3

def runner():
    '''
    Return all inline documetation for runner modules
    '''
    client = salt.runner.RunnerClient(__opts__)
    ret = client.get_docs()
    salt.output.display_output(ret, '', __opts__)
    return ret

Example #4

File: doc.py Project: herlo/salt

def wheel():
    '''
    Return all inline documentation for wheel modules
    '''
    client = salt.wheel.Wheel(__opts__)
    ret = client.get_docs()
    salt.output.display_output(ret, '', __opts__)
    return ret

Example #5

File: doc.py Project: herlo/salt

def runner():
    '''
    Return all inline documetation for runner modules
    '''
    client = salt.runner.RunnerClient(__opts__)
    ret = client.get_docs()
    salt.output.display_output(ret, '', __opts__)
    return ret

Example #6

File: doc.py Project: zeus911/ops

def wheel():
    '''
    Return all inline documentation for wheel modules

    CLI Example:

    .. code-block:: bash

        salt-run doc.wheel
    '''
    client = salt.wheel.Wheel(__opts__)
    ret = client.get_docs()
    return ret

Example #7

File: doc.py Project: zeus911/ops

def runner():
    '''
    Return all inline documentation for runner modules

    CLI Example:

    .. code-block:: bash

        salt-run doc.runner
    '''
    client = salt.runner.RunnerClient(__opts__)
    ret = client.get_docs()
    return ret

Example #8

File: doc.py Project: bryson/salt

def wheel():
    '''
    Return all inline documentation for wheel modules

    CLI Example:

    .. code-block:: bash

        salt-run doc.wheel
    '''
    client = salt.wheel.Wheel(__opts__)
    ret = client.get_docs()
    return ret

Example #9

File: doc.py Project: bryson/salt

def runner():
    '''
    Return all inline documentation for runner modules

    CLI Example:

    .. code-block:: bash

        salt-run doc.runner
    '''
    client = salt.runner.RunnerClient(__opts__)
    ret = client.get_docs()
    return ret

Example #10

File: doc.py Project: wikimedia/operations-debs-salt

def wheel():
    """
    Return all inline documentation for wheel modules

    CLI Example:

    .. code-block:: bash

        salt-run doc.wheel
    """
    client = salt.wheel.Wheel(__opts__)
    ret = client.get_docs()
    salt.output.display_output(ret, "", __opts__)
    return ret

Example #11

File: doc.py Project: wikimedia/operations-debs-salt

def runner():
    """
    Return all inline documentation for runner modules

    CLI Example:

    .. code-block:: bash

        salt-run doc.runner
    """
    client = salt.runner.RunnerClient(__opts__)
    ret = client.get_docs()
    salt.output.display_output(ret, "", __opts__)
    return ret