Como usar o autodoc do Sphinx para documentar o método __init __ (self) de uma classe?

O Sphinx não gera documentos para __init __ (self) por padrão. Eu tentei o seguinte:

.. automodule:: mymodule
    :members:

e

..autoclass:: MyClass
    :members:

Em conf.py, definir o seguinte apenas anexa a docstring __init __ (self) à docstring da classe ( a documentação do autodoc do Sphinx parece concordar que esse é o comportamento esperado, mas não menciona nada sobre o problema que estou tentando resolver):

autoclass_content = 'both'

Aqui estão três alternativas:

1. Para garantir que __init__()esteja sempre documentado, você pode usar autodoc-skip-memberem conf.py. Como isso:

   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)

   Isso define explicitamente __init__não deve ser ignorado (o que é por padrão). Essa configuração é especificada uma vez e não requer nenhuma marcação adicional para todas as classes na fonte .rst.

2. A special-membersopção foi adicionada no Sphinx 1.1 . Faz com que membros "especiais" (aqueles com nomes como __special__) sejam documentados pelo autodoc.

   Desde o Sphinx 1.2, esta opção aceita argumentos que a tornam mais útil do que era anteriormente.

3. Use automethod:

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

   Isso deve ser adicionado para todas as classes (não pode ser usado com automodule, como apontado em um comentário à primeira revisão desta resposta).

Você estava perto. Você pode usar a autoclass_contentopção em seu conf.pyarquivo:

autoclass_content = 'both'

Nos últimos anos tenho escrito várias variantes de autodoc-skip-memberretornos de chamada para vários projetos Python não relacionados porque eu queria métodos gosto __init__(), __enter__()e __exit__()para mostrar-se na minha documentação da API (afinal, esses "métodos especiais" são parte da API e que melhor lugar para documentá-los do que dentro da docstring do método especial).

Recentemente, peguei a melhor implementação e a incluí em um dos meus projetos Python ( aqui está a documentação ). A implementação basicamente se resume a isto:

import types

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

Sim, há mais documentação do que lógica :-). A vantagem de definir um autodoc-skip-memberretorno de chamada como esse sobre o uso da special-membersopção (para mim) é que a special-membersopção também permite a documentação de propriedades como __weakref__(disponível em todas as classes de novo estilo, AFAIK) que considero ruído e nada útil. A abordagem de retorno de chamada evita isso (porque só funciona em funções / métodos e ignora outros atributos).

Embora esta seja uma postagem mais antiga, para quem está pesquisando a partir de agora, existe também outra solução introduzida na versão 1.8. De acordo com a documentação , você pode adicionar a special-memberchave em autodoc_default_options ao seu conf.py.

Exemplo:

autodoc_default_options = {
    'members': True,
    'member-order': 'bysource',
    'special-members': '__init__',
    'undoc-members': True,
    'exclude-members': '__weakref__'
}

Esta é uma variante que inclui apenas __init__se tiver argumentos:

import inspect

def skip_init_without_args(app, what, name, obj, would_skip, options):
    if name == '__init__':
        func = getattr(obj, '__init__')
        spec = inspect.getfullargspec(func)
        return not spec.args and not spec.varargs and not spec.varkw and not spec.kwonlyargs
    return would_skip

def setup(app):
    app.connect("autodoc-skip-member", skip_init_without_args)