[python] Poetry를 사용하여 파이썬 패키지의 문서화 작업을 할 수 있습니다.

04 Dec 2023

python

파이썬 패키지를 개발할 때 문서화 작업은 매우 중요합니다. 문서화를 통해 다른 개발자들이 우리가 만든 패키지를 쉽게 이해하고 사용할 수 있습니다. 이번에는 Poetry를 사용하여 파이썬 패키지의 문서화 작업을 어떻게 할 수 있는지 알아보겠습니다.

Poetry란?

Poetry는 파이썬의 패키지 및 의존성 관리 도구입니다. Poetry를 사용하면 프로젝트의 의존성을 관리하고, 가상 환경을 생성하고, 패키지를 빌드하고, 배포하는 등의 작업을 편리하게 수행할 수 있습니다. 이번 예제에서는 Poetry를 사용하여 문서화를 진행해보겠습니다.

패키지 문서화 작업하기

Poetry 설치하기

Poetry를 사용하기 위해 먼저 설치해야 합니다. 터미널에서 다음 명령을 실행하여 Poetry를 설치합니다.
```
pip install poetry
```
프로젝트 생성하기

다음 명령을 실행하여 새로운 프로젝트를 생성합니다.
```
poetry new mypackage
```
문서화 준비하기

문서화를 위해 몇 가지 사전 작업이 필요합니다. mypackage 디렉토리로 이동한 후, pyproject.toml 파일을 열어 다음 내용을 추가합니다.
```
[tool.poetry.scripts]
docs = "mkdocs serve"
```
이렇게 하면 docs 명령어를 사용하여 문서화를 진행할 수 있게 됩니다.
문서화 패키지 설치하기

문서화를 위해 mkdocs를 사용하겠습니다. 터미널에서 다음 명령을 실행하여 mkdocs를 설치합니다.
```
pip install mkdocs
```
문서화 작업하기

mypackage 디렉토리로 이동한 후, 다음 명령을 실행하여 문서화 작업을 시작합니다.
```
poetry run docs
```
이제 mkdocs 서버가 실행되고 문서화 작업이 시작됩니다. 브라우저에서 http://localhost:8000에 접속하면 문서화된 내용을 확인할 수 있습니다.
문서화 배포하기

문서화를 완료한 후, 배포를 위해 다음 명령을 실행하여 정적 파일을 생성합니다.
```
poetry run mkdocs build
```
이제 site 디렉토리에 문서화된 내용의 정적 파일들이 생성되었습니다. 이를 웹 서버에 배포하면 다른 사용자들도 접근할 수 있습니다.

Poetry를 사용하여 파이썬 패키지의 문서화 작업을 수행하는 방법을 알아보았습니다. 이를 통해 다른 개발자들은 우리가 만든 패키지를 더욱 쉽게 이용할 수 있게 됩니다. 참고로 Poetry에는 다양한 기능들이 있으니 공식 문서를 참조하면 더 많은 정보를 얻을 수 있습니다.

Poetry 공식 홈페이지: https://python-poetry.org/
MkDocs 공식 홈페이지: https://www.mkdocs.org/