Python 문서화 - Docstring and Sphinx

Sphinx와 Docstring은 무엇인가

Docstring 은 파이썬에서 코드 문서화를 위한 reStructured Text 형태의 주석을 말한다. reStructured Text는 코딩 관련 기술 문서를 작성할 때 가벼운 문법으로 작성하는 마크업 언어 중 하나이다.

Sphinx는 이 Docstring을 자동으로 문서화 해주는 툴이다.

Sphinx 설치

pip install sphinx

Sphinx 사용

# rst 소스 생성
sphinx-apidoc -e -F -o docs ./
# rst 소스 빌드
sphinx-build  docs/