show * only * docstring in Sphinx documentation

Question

스핑크스는 automethod이라는 기능을 사용하여 메소드의 문서화 문자열에서 문서를 추출하여 문서에 삽입합니다. 그러나 문서 문자열뿐만 아니라 메서드 서명 (name + arguments)도 포함합니다. 문서 문자열 만 삽입하려면 어떻게해야합니까 (메서드 서명 제외)?

심판 : http://sphinx.pocoo.org/ext/autodoc.html

Answer 1

내가 무슨 생각을 당신이 찾고있는 것은 :

from sphinx.ext import autodoc 

class DocsonlyMethodDocumenter(autodoc.MethodDocumenter): 
    def format_args(self): 
    return None 

autodoc.add_documenter(DocsonlyMethodDocumenter) 

는 the current sources 당이 (add_documenter의 이전 버전은 오버라이드 (override)를 금지 방법을 문서화에 대한 책임이 무엇 클래스 무시 허용해야합니다, 하지만 이제는 명시 적으로 허용됩니다). format_args을 반환하는 것은 물론, 없음은 "서명을 고수하지 마십시오"라고 말하는 autodoc의 문서화 된 방식입니다.

저는 이것이이 작업을 수행하기위한 깨끗하고 체계적인 방법이라고 생각합니다. 따라서, 대안으로 monkeypatching하는 것이 더 좋습니다. sphinx의 일부 구버전을 가지고 살아야 할 필요가 있다면 특정 배포에서 가능한 한 더 나은 접근 방법으로 현재 버전으로 업그레이드하는 것이 좋지만 (autodoc.MethodDocumenter.format_args=lambda _:None - eek! -) monkeypatch해야 할 수도 있습니다.