Sphinx보다 가벼운 대안으로, Google 스타일 Python docstring에서 Markdown API 문서를 생성하는 CLI 도구입니다.
25342PythonMIT업데이트 16일 전
#docstring
이 도구들은 Python 독스트링을 다루며 API 문서 생성, 독스트링 적용률 측정, 형식 통일에 쓰입니다. 문서 생성, 누락 확인, 형식 정리 중 필요한 단계부터 정하는 것이 좋습니다. pdoc3/pdoc는 특별한 설정 없이 모듈과 패키지에서 문서를 만들지만 AGPL-3.0 라이선스이므로 상업적 사용 시 확인이 필요합니다. econchick/interrogate는 함수, 클래스, 모듈의 적용률을 측정하고 CI에서 통과 기준을 설정할 수 있습니다. PyCQA/docformatter는 PEP 257에 맞게 독스트링을 재정렬합니다.
Sphinx보다 가벼운 대안으로, Google 스타일 Python docstring에서 Markdown API 문서를 생성하는 CLI 도구입니다.
NumPy 스타일 docstring을 파싱해 구조화된 API 문서로 렌더링하는 Sphinx 확장입니다.
PEP 257 규약에 맞게 docstring을 자동으로 다시 포맷하는 Python CLI 도구입니다.
코드베이스의 함수, 클래스, 메서드, 모듈 중 docstring이 작성된 항목의 비율을 측정하고, CI에 적합한 통과·실패 기준을 적용하는 Python CLI입니다.
특별한 설정 없이 모듈, 패키지, docstring에서 Python 3 프로젝트의 API 문서를 자동 생성합니다.