How do I document a module in Python?

Question

That's it. If you want to document a function or a class, you put a string just after the definition. For instance:

def foo():     """This function does nothing."""     pass 

But what about a module? How can I document what a file.py does?

Answer 1

Add your docstring as the first statement in the module.

""" Your module's verbose yet thorough docstring. """  import foo  # ... 

For packages, you can add your docstring to __init__.py.

Answer 2

For the packages, you can document it in __init__.py. For the modules, you can add a docstring simply in the module file.

All the information is here: http://www.python.org/dev/peps/pep-0257/