Как мне документировать модуль в Python?

Question

Вот и все. Если вы хотите задокументировать функцию или класс, вы помещаете строку сразу после определения. Например:

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

А как насчет модуля? Как я могу документировать, что делает file.py ?

Answer 1

Добавьте строку документации как первый оператор в модуле .

"""
Your module's verbose yet thorough docstring.
"""

import foo

# ...

Для пакетов вы можете добавить свою строку документации в __init__.py.

Answer 2

Для пакетов вы можете документировать это в __init__.py. Для модулей вы можете добавить строку документации просто в файл модуля.

Вся информация здесь: http://www.python.org/dev/peps/pep-0257/

Answer 3

Вот Пример строки документации Python в Google Style о том, как модуль может быть задокументирован. В основном это информация о модуле, как его выполнять, информация о переменных уровня модуля и список элементов ToDo.

"""Example Google style docstrings.

This module demonstrates documentation as specified by the `Google
Python Style Guide`_. Docstrings may extend over multiple lines.
Sections are created with a section header and a colon followed by a
block of indented text.

Example:
    Examples can be given using either the ``Example`` or ``Examples``
    sections. Sections support any reStructuredText formatting, including
    literal blocks::

        $ python example_google.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.

Attributes:
    module_level_variable1 (int): Module level variables may be documented in
        either the ``Attributes`` section of the module docstring, or in an
        inline docstring immediately following the variable.

        Either form is acceptable, but the two should not be mixed. Choose
        one convention to document module level variables and be consistent
        with it.

Todo:
    * For module TODOs
    * You have to also use ``sphinx.ext.todo`` extension

.. _Google Python Style Guide:   
http://google.github.io/styleguide/pyguide.html

"""

module_level_variable1 = 12345

def my_function():   
    pass 
... 
...

Answer 4

Вы делаете это точно так же. Вставьте строку в качестве первого оператора в модуле.

Answer 5

Это просто, вы просто добавляете строку документации вверху модуля.