[Tutor] Basic question about docstrings

David Aldrich David.Aldrich at EMEA.NEC.COM
Wed Jul 29 17:45:55 CEST 2015


Hi

If I have a script called main.py and document a function in it:

def get_value(x):
    """
    Some text ...
    :param x:     Some value
    :returns:      Something useful
    """

What is the most basic way of showing those docstrings at the Python prompt?

For getting started with documentation, is Sphinx a good way to go, or would you recommend something simpler?

Best regards

David



More information about the Tutor mailing list