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

Ответ 1

Вот три варианта:

1. Чтобы __init__() всегда документировался, вы можете использовать autodoc-skip-member в conf.py. Как это:

   def skip(app, what, name, obj, would_skip, options):
       if name == "__init__":
           return False
       return would_skip
   
   def setup(app):
       app.connect("autodoc-skip-member", skip)
   

   Это явно определяет, что __init__ не должен быть пропущен (что по умолчанию). Эта конфигурация указывается один раз, и она не требует какой-либо дополнительной разметки для каждого класса в .rst источнике.

2. Опция special-members была добавлена в Sphinx 1.1. Это заставляет "специальные" элементы (имена с такими именами, как __special__) документироваться autodoc.

   Начиная с Sphinx 1.2, эта опция принимает аргументы, что делает ее более полезной, чем это было ранее.

3. Использовать automethod:

   .. autoclass:: MyClass     
      :members: 
   
      .. automethod:: __init__
   

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

Ответ 2

Вы были близки Вы можете использовать опцию autoclass_content в вашем файле conf.py:

autoclass_content = 'both'

Ответ 3

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

Недавно я взял лучшую реализацию и сделал ее частью одного из моих проектов на Python (здесь документация). Реализация в основном сводится к этому:

def setup(app):
    """Enable Sphinx customizations."""
    enable_special_methods(app)


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 ) который я считаю шумом и совсем не полезен. Подход обратного вызова избегает этого (потому что он работает только на функции/методы и игнорирует другие атрибуты).