Rodrigo Girão Serrão: TIL #135 – 파이썬 문서 만들기

저자는 변경 사항을 검토하기 위해 Python 문서를 로컬에서 빌드하고 미리 보는 방법을 발견했습니다. 이를 위해 `make -C Doc venv htmllive` 명령을 사용했는데, 이 명령은 실시간 리로딩 기능도 제공합니다. 저자는 `concurrent.interpreters` 모듈의 문서에서 "See also" 콜아웃이 정렬되지 않는 시각적 문제를 발견했습니다. 이 문제는 들여쓰기 때문에 주석 블록이 잘못된 형식의 blockquote로 처리된 데서 비롯되었습니다. reStructuredText (rST)에 익숙하지 않았던 저자는 처음에는 근본 원인을 파악하는 데 어려움을 겪었습니다. 몇 번의 조사를 거친 후, 주석에서 공백 하나를 제거하면 문제가 해결된다는 것을 발견했습니다. 저자는 더 나아가 문서를 개선하기 위해 문장의 첫 글자를 대문자로 바꾸고 마침표를 추가했습니다. 그 결과, "See also" 섹션의 모양이 크게 개선되어 처음의 문제가 해결되었습니다. 문서를 로컬에서 빌드하고 미리 보는 것은 문제를 식별하고 해결하는 효과적인 방법이었습니다. 저자는 개선된 시각적 표현에 만족감을 나타냈습니다.