Sphinxのautodocを使用してクラスの__init __（self）メソッドをドキュメント化する方法は？

Sphinxはデフォルトでは__init __（self）のドキュメントを生成しません。私は以下を試しました：

.. automodule:: mymodule
    :members:

そして

..autoclass:: MyClass
    :members:

conf.pyで、次の設定は__init __（self）docstringをクラスdocstringに追加するだけです（Sphinx autodocドキュメントはこれが予想される動作であることに同意しているようですが、私が解決しようとしている問題については何も言及していません）。

autoclass_content = 'both'

ここに3つの選択肢があります：

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この回答の最初のリビジョンへのコメントで指摘されているように、では使用できません）。

あなたは近くにいた。ファイルでautoclass_contentオプションを使用できconf.pyます。

autoclass_content = 'both'

過去数年にわたり、私はいくつかのバリエーション書いてきたautodoc-skip-member私のような方法を望んでいたので、様々な関連のないPythonのプロジェクトのためのコールバックを__init__()、__enter__()そして__exit__()私のAPIドキュメントに表示する（すべての後に、これらの「特別な方法は、」APIの一部と何に場所優れています特別なメソッドのdocstring内よりもそれらを文書化します）。

最近、私は最良の実装を採用し、それを私のPythonプロジェクトの一部にしました（ここにドキュメントがあります）。実装は基本的にこれに帰着します：

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

はい、ロジックよりも多くのドキュメントがあります:-)。（私にとって）オプションautodoc-skip-memberの使用に対するこのようなコールバックの定義の利点special-membersは、このspecial-membersオプションによって__weakref__、ノイズを考慮し、まったく役に立たない（すべての新しいスタイルのクラス、AFAIKで利用可能）などのプロパティのドキュメント化も有効になることです。コールバックアプローチはこれを回避します（関数/メソッドでのみ機能し、他の属性を無視するため）。

これは古い投稿ですが、現時点で調べている人のために、バージョン1.8で導入された別のソリューションもあります。ドキュメントによると、special-memberautodoc_default_options のキーをに追加でき ますconf.py。

例：

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

これは、__init__引数がある場合にのみ含まれるバリアントです。

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)