파이썬 패키지 문서화에 NumPyDoc 스타일 docstrings을 사용하고 있습니다. 'numpydoc' 스핑크스 확장을 Napoleon으로 바꾸고 싶습니다. 더 작고 읽기 쉬운 방법으로 문서화 문자열을 포맷합니다. 그러나 numpydoc의 매우 귀중한 기능을 발견 한 문서 상단에 클래스의 메서드가 나열되어 있지 않습니다. 사람이 나폴레옹 수동으로 전환하는 방법을 알고 있습니까?NumPyDoc 스타일을 사용하는 Napoleon Sphinx 확장 클래스 메서드 목록
나폴레옹/스핑크스를 처음 접했지만, 그 대답은 나폴레옹이 아닌 스핑크스에있을 것이라고 생각합니다.
conf.py에서 autodoc을 활성화 한 경우.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.coverage']
후 (말) 당신의 index.rst에 추가 : module_name 문제의 클래스를 포함
.. autoclass:: module_name.class_name
:members:
:undoc-members:
후 class_name는 모든 메소드와 함께 문서에있을 것입니다, 경우에도 그들은 현재 문서화 문자열이 없습니다.