함수 또는 문서에 대한 정보는 함수의 독스트링에 저장됩니다. 다음은 독스트링을 작성할 때 따라야 할 지침입니다.
첫 번째 줄은 항상 개체의 목적에 대한 짧고 간결한 요약이어야 합니다. 간결함을 위해 개체의 이름이나 유형을 명시적으로 나타내지 않아야 합니다. 이 줄은 대문자로 시작하고 마침표로 끝나야 합니다.
문서 문자열에 줄이 더 있는 경우 두 번째 줄은 비어 있어야 하며 나머지 설명과 요약을 시각적으로 구분합니다.
스핑크스
Sphinx는 가장 널리 사용되는 Python 문서 도구입니다. reStructuredText 마크업 언어를 HTML, LaTeX(인쇄 가능한 PDF 버전용), 매뉴얼 페이지 및 일반 텍스트를 포함한 다양한 출력 형식으로 변환합니다.
실행되면 Sphinx는 코드를 가져오고 Python의 자체 검사 기능을 사용하여 모든 함수, 메서드 및 클래스 서명을 추출합니다. 또한 함께 제공되는 독스트링을 추출하여 프로젝트에 대해 잘 구조화되고 쉽게 읽을 수 있는 문서로 컴파일합니다.