autodoc docstring에서 코드 실행

Question

Sphinx 및 autodoc을 사용하여 Python 프로젝트를 문서화 할 때 :Example:을 사용하면 모듈/클래스/함수 docstring에 코드 샘플을 포함 할 수 있습니다.이 코드 샘플은 Sphinx에서 친절하게 구문 강조 표시됩니다. 그렇게하는 것.

>>> rng = Range(0, 1000) 
>>> rng 
[0, 1000) 
>>> len(rng) 
1000 
>>> rng.start = 500 
>>> rng.start 
500 
>>> rng.end 
1000 
>>> 

파이썬 인터프리터에서 복사하여 붙여 넣었습니다. Sphinx 또는 autodoc에서 코드를 실행하고 문서의 출력을 자동으로 캡처 할 수있는 방법이 있습니까?

내 주 관심사는 복사 및 붙여 넣기 코드/출력이 실제 현재 코드 동작과 동기화되지 않는 것입니다.

Answer 1

표준 라이브러리에는 텍스트 파일이나 문서 문자열에서 대화 형 예제를 식별, 실행 및 확인할 수있는 doctest이 포함되어 있습니다.