How do I document a module in Python?
<p>That's it. If you want to document a function or a class, you put a string just after the definition. For instance:</p>

<pre><code>def foo():
    """This function does nothing."""
    pass
</code></pre>

<p>But what about a module? How can I document what a <em>file.py</em> does?</p>

<p>For the packages, you can document it in <code>__init__.py</code>.
For the modules, you can add a docstring simply in the module file.</p>

<p>All the information is here: <a href="http://www.python.org/dev/peps/pep-0257/">http://www.python.org/dev/peps/pep-0257/</a></p>
