Как использовать autodoc Сфинкса для документирования метода init (self) класса?

Question

Как использовать autodoc Сфинкса для документирования метода init (self) класса?

Sphinx не создает документы для __init__(self) по умолчанию. Я пробовал следующее:

.. automodule:: mymodule

    :members:

и

..autoclass:: MyClass

    :members:

В conf.py установка следующим добавляет только в __инит__(самостоятельная) строкой документации для строкой документации класса (документация Sphinx autodoc кажется, согласны, что это ожидаемое поведение, но ничего не упоминает о проблеме, которую я пытаюсь разгадать):

autoclass_content = 'both'

483 3

python python-sphinx autodoc

3 ответов:

Comments

Ничего не найдено.

mzjn · Accepted Answer · 2014-02-26 22:45:02

вот три варианта:
обеспечить __init__() всегда документируется, вы можете использовать autodoc-skip-member in conf.py вот так:
def skip(app, what, name, obj, skip, options):
    if name == "__init__":
        return False
    return skip

def setup(app):
    app.connect("autodoc-skip-member", skip)
это явно определяет __init__ не пропускается (что по умолчанию). Эта конфигурация указывается один раз, и она не требует дополнительной разметки для каждого класса .первый источник.
The special-members был добавлено в Sphinx 1.1. Это делает" специальные " члены (те, с именами, как __special__) подтверждается Автодок.

поскольку Sphinx 1.2, этот параметр принимает аргументы, которые делают его более полезным, чем это было ранее.
использовать automethod:
.. autoclass:: MyClass     
   :members: 

   .. automethod:: __init__
это должно быть добавлено для каждого класса (не может использоваться с automodule, как указано в комментарии к первой редакции этого ответа).

gotgenes · Accepted Answer · 2017-04-27 17:51:54

Вы были близки. Вы можете использовать autoclass_content в своем conf.py file:
autoclass_content = 'both'

xolox · Accepted Answer · 2016-02-19 00:02:40

за последние годы я написал несколько вариантов autodoc-skip-member обратные вызовы для различных несвязанных проектов Python, потому что мне нужны такие методы, как __init__(),__enter__() и __exit__() чтобы показать в моей документации API (в конце концов, эти "специальные методы" являются частью API и какое лучшее место для их документирования, чем внутри docstring специального метода).

недавно я взял лучшую реализацию и сделал ее частью одного из моих проектов Python (здесь документация). Реализация в основном сводится к следующему:
def enable_special_methods(app):
    """
    Enable documenting "special methods" using the autodoc_ extension.

    :param app: The Sphinx application object.

    This function connects the :func:`special_methods_callback()` function to
    ``autodoc-skip-member`` events.

    .. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
    """
    app.connect('autodoc-skip-member', special_methods_callback)


def special_methods_callback(app, what, name, obj, skip, options):
    """
    Enable documenting "special methods" using the autodoc_ extension.

    Refer to :func:`enable_special_methods()` to enable the use of this
    function (you probably don't want to call
    :func:`special_methods_callback()` directly).

    This function implements a callback for ``autodoc-skip-member`` events to
    include documented "special methods" (method names with two leading and two
    trailing underscores) in your documentation. The result is similar to the
    use of the ``special-members`` flag with one big difference: Special
    methods are included but other types of members are ignored. This means
    that attributes like ``__weakref__`` will always be ignored (this was my
    main annoyance with the ``special-members`` flag).

    The parameters expected by this function are those defined for Sphinx event
    callback functions (i.e. I'm not going to document them here :-).
    """
    if getattr(obj, '__doc__', None) and isinstance(obj, (types.FunctionType, types.MethodType)):
        return False
    else:
        return skip
Да, там больше документации, чем логики :-). Преимущество определения autodoc-skip-member обратный вызов, как это над использованием special-members вариант (для меня) является то, что special-members опция также позволяет документировать свойства, такие как __weakref__ (доступно на всех классах нового стиля, AFAIK), которые я считаю шумными и не полезными вообще. Подход обратного вызова позволяет избежать этого (потому что он работает только на функции/методы и игнорирует другие атрибуты).