스핑크스의 오토독을 사용하여 클래스의 __init__(self) 메서드를 문서화하는 방법은 무엇입니까?

스핑크스의 오토독을 사용하여 클래스의 __init__(self) 메서드를 문서화하는 방법은 무엇입니까?

스핑크스는 기본적으로 __init__(self)에 대한 문서를 생성하지 않습니다.저는 다음을 시도해 보았습니다.

.. automodule:: mymodule
    :members:

그리고.

..autoclass:: MyClass
    :members:

conf.py 에서 다음을 설정하면 __init__(self) docstring만 클래스 docstring에 추가됩니다. (스핑크스 자동 문서에서는 이것이 예상되는 동작이라는 것에 동의하지만, 내가 해결하려는 문제에 대해서는 언급하지 않습니다.)

autoclass_content = 'both'

다음과 같은 세 가지 대안이 있습니다.

1. 확실히 하기 위해서는__init__()는 항상 문서화되어 있으며, 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. 이 옵션은 스핑크스 1.1에 추가되었습니다.그것은 "특별한" 멤버들을 만듭니다.__special__오토닥에 의해 문서화됩니다.

   스핑크스 1.2 이후 이 옵션은 인수를 사용하므로 이전보다 유용합니다.

3. 사용하다automethod:

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

   클래스마다 추가해야 합니다(사용할 수 없음).automodule, 본 답변의 제1차 개정 의견에서 지적한 바와 같이).

가까웠잖아요.의 옵션을 사용할 수 있습니다.conf.py파일:

autoclass_content = 'both'

오래된 게시물임에도 불구하고 현재 찾아보는 분들을 위해 버전 1.8에 도입된 또 다른 솔루션도 있습니다.문서에 따르면, 당신은 다음을 추가할 수 있습니다.special-members열쇠를 쥐고 있는autodoc_default_options당신에게conf.py.

예:

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

지난 몇 년 동안 저는 몇 가지 변형된 정보를 썼습니다.autodoc-skip-member나는 다음과 같은 방법을 원했기 때문에 관련이 없는 다양한 파이썬 프로젝트에 대한 콜백.__init__(),__enter__()그리고.__exit__()API 문서에 표시됩니다(결국, 이러한 "특별한 메소드"는 API의 일부이며 특별한 메소드의 문서 문자열 내부보다 문서화하기에 더 좋은 장소입니다).

최근에 저는 최상의 구현을 수행하여 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) 소음으로 인해 전혀 유용하지 않다고 생각합니다.콜백 접근 방식은 기능/메소드에서만 작동하고 다른 속성은 무시하기 때문에 이를 방지합니다.

이 커밋이 승인된 한 다음 스핑크스 버전(>4.1.2)의 https://github.com/sphinx-doc/sphinx/pull/9154, 은 다음 작업을 수행할 수 있습니다.

..autoclass:: MyClass1
    :members:
    :class-doc-from: class


..autoclass:: MyClass2
    :members:
    :class-doc-from: init

은 을 하는 입니다 입니다 하는 은 을 __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)

언급URL : https://stackoverflow.com/questions/5599254/how-to-use-sphinxs-autodoc-to-document-a-classs-init-self-method