python-sphinx
autodoc을 사용하여 문서 문자열 작성하기
수색…
소개
Sphinx는 패키지와 함께 제공되는 autodoc 확장 을 사용하여 문서에 문서 문자열을 포함시킬 수 있습니다. 이 문서는 문서화 문자열의 형식을 지정하는 방법을 문서에 포함시키는 방법을 보여줍니다.
autodoc 확장 기능 설치하기
문서의 루트에있는 conf.py 파일에있는 extensions list 에 autodoc 모듈을 추가하십시오.
extensions = [
'sphinx.ext.autodoc',
...
]
스핑크스 설정에 코드 경로 추가하기
Autodoc은 모듈을 임포트하여 가져와야합니다.
conf.py 파일에 코드 경로를 포함 할 수 있습니다.
예를 들면 :
import os
sys.path.insert(0, os.path.abspath('../src'))
Modified text is an extract of the original Stack Overflow Documentation
아래 라이선스 CC BY-SA 3.0
와 제휴하지 않음 Stack Overflow