Bagaimana cara menggunakan autodoc Sphinx untuk mendokumentasikan metode __init __ (self) kelas?

Sphinx tidak membuat dokumen untuk __init __ (self) secara default. Saya telah mencoba yang berikut ini:

.. automodule:: mymodule
    :members:

dan

..autoclass:: MyClass
    :members:

Di conf.py, pengaturan berikut hanya menambahkan docstring __init __ (self) ke kelas docstring ( dokumentasi autodoc Sphinx sepertinya setuju bahwa ini adalah perilaku yang diharapkan, tapi tidak menyebutkan apapun mengenai masalah yang saya coba selesaikan):

autoclass_content = 'both'

Berikut tiga alternatif:

1. Untuk memastikan bahwa __init__()selalu didokumentasikan, Anda dapat menggunakan autodoc-skip-memberdi conf.py. Seperti ini:

   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)
   

   Ini secara eksplisit mendefinisikan __init__untuk tidak dilewati (yang secara default). Konfigurasi ini ditentukan sekali, dan tidak memerlukan markup tambahan untuk setiap kelas di sumber .rst.

2. The special-memberspilihan yang ditambahkan dalam Sphinx 1.1 . Itu membuat anggota "khusus" (mereka yang memiliki nama seperti __special__) didokumentasikan oleh autodoc.

   Sejak Sphinx 1.2, opsi ini membutuhkan argumen yang membuatnya lebih berguna daripada sebelumnya.

3. Penggunaan automethod:

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

   Ini harus ditambahkan untuk setiap kelas (tidak dapat digunakan dengan automodule, seperti yang ditunjukkan dalam komentar pada revisi pertama jawaban ini).

Anda sudah dekat. Anda dapat menggunakan autoclass_contentopsi di conf.pyfile Anda :

autoclass_content = 'both'

Selama beberapa tahun terakhir saya telah menulis beberapa varian autodoc-skip-membercallback untuk berbagai proyek Python yang tidak terkait karena saya ingin metode seperti __init__(), __enter__()dan __exit__()muncul dalam dokumentasi API saya (bagaimanapun, "metode khusus" ini adalah bagian dari API dan tempat apa yang lebih baik untuk mendokumentasikannya daripada di dalam docstring metode khusus).

Baru-baru ini saya mengambil implementasi terbaik dan menjadikannya bagian dari salah satu proyek Python saya ( berikut dokumentasinya ). Implementasinya pada dasarnya bermuara pada ini:

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

Ya, ada lebih banyak dokumentasi daripada logika :-). Keuntungan mendefinisikan autodoc-skip-memberpanggilan balik seperti ini dibandingkan penggunaan special-membersopsi (bagi saya) adalah bahwa special-membersopsi tersebut juga mengaktifkan dokumentasi properti seperti __weakref__(tersedia di semua kelas gaya baru, AFAIK) yang menurut saya berisik dan tidak berguna sama sekali. Pendekatan callback menghindari ini (karena hanya bekerja pada fungsi / metode dan mengabaikan atribut lain).

Meskipun ini adalah posting yang lebih lama, tetapi bagi mereka yang melihatnya seperti sekarang, ada juga solusi lain yang diperkenalkan di versi 1.8. Menurut dokumentasi , Anda dapat menambahkan special-memberkunci dalam autodoc_default_options ke conf.py.

Contoh:

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

Ini adalah varian yang hanya disertakan __init__jika memiliki argumen:

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)