아프니까 개발자다 아프니까 개발자다

"수동 유지 불가능" 앞에서 선택한 길함수 수백 개, 클래스 수십 개, 공개 API 전부에 수동으로 설명서를 붙이는 건 유지보수가 불가능하다. 6개월만 지나도 시그니처가 바뀌고 문서는 그대로 거짓말을 한다. 그래서 자동 생성 도구가 필요하다. Python 생태계에서 2008년에 등장해 지금도 사실상 표준인 도구가 바로 Sphinx다.Sphinx의 핵심은 한 문장으로 요약된다. "코드 안의 docstring을 읽어서 HTML 문서 사이트로 자동 변환한다". 함수 설명을 코드 옆에 한 번 쓰면, CI가 돌 때마다 자동으로 사이트가 갱신된다. 사람은 docstring만 쓰고, Sphinx가 나머지를 다 한다.Sphinx가 왜 나왔는가 — 해결하려던 3가지 문제Sphinx는 Georg Brandl이 Python..