많은 Python 패키지 및 라이브러리 문서들은 일반적으로 GitHub 등에서 사용하는 Markdown 문법이 아닌, rst (Restructured Text) 문법을 사용하여 작성이 이루어지며, Sphinx 라이브러리를 활용하여 html 또는 pdf로 build하여 해당 패키지 및 라이브러리 문서화를 관리하고 있습니다. 본 발표에서는 rst가 무엇인지부터 시작하여, rst와 관련된 기본 문법을 통해 html 또는 pdf로 어떻게 생성할 수 있는지 각 단계별로 살펴봄으로써 Python 문서화가 이루어지는 전반적인 과정을 먼저 살펴봅니다. 이후, Python을 활용하고 있는 OpenStack 프로젝트에서 문서를 code처럼 관리하기로 결정한 이후, rst 기반으로 설치 가이드 등을 작성하고 Sphinx 및 별도 theme를 적용하여 html 및 pdf를 생성하여 활용하는 실 활용 사례를 같이 살펴보고자 합니다.
