Poetry는 파이썬 패키지의 종속성 관리와 가상 환경을 편리하게 관리하기 위한 도구입니다. 하지만 Poetry는 더 많은 기능을 제공합니다. 포기의 문서화도 Poetry를 사용하여 자동으로 생성할 수 있습니다. 이번 튜토리얼에서는 Poetry를 사용하여 파이썬 패키지의 문서화를 자동으로 생성하는 방법을 알아보겠습니다.

1. Poetry 설치

Poetry를 사용하기 위해서는 먼저 설치해야 합니다. 다음 명령어를 사용하여 Poetry를 설치합니다.

pip install poetry

2. Poetry 프로젝트 생성

문서화를 하고자 하는 파이썬 패키지의 루트 디렉토리에서 다음 명령어를 사용하여 Poetry 프로젝트를 생성합니다.

poetry new --src <프로젝트명>

이렇게 하면 Poetry에서 사용하는 디렉토리 구조가 준비됩니다.

3. 문서화 작업

문서화를 위해 Poetry에서는 pyproject.toml 파일을 사용합니다. 이 파일에 문서화 설정을 추가하여 문서화를 자동으로 생성할 수 있습니다. 다음은 pyproject.toml 파일의 예입니다.

[tool.poetry]
name = "my-package"
version = "0.1.0"
description = "My Python package"
readme = "README.md"
license = "MIT"
authors = ["Your Name <your-email@example.com>"]

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
pytest = "^5.0"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

위에서 readme 설정에 README.md 파일을 지정하면, Poetry는 해당 파일을 기반으로 문서화를 생성합니다.

4. 문서화 자동 생성

패키지를 문서화할 준비가 되었다면, Poetry에서 poetry build 명령어를 사용하여 문서화를 자동으로 생성합니다.

poetry build

위 명령어를 실행하면 dist 디렉토리에 여러가지 포맷의 문서화 파일들이 생성됩니다. 예를 들어, Markdown으로 작성된 문서는 dist/<프로젝트명>-<버전>.tar.gz 파일 내에 포함되어 있습니다.

5. 자동 생성된 문서 확인

앞서 생성된 Markdown 문서를 확인하기 위해 dist 디렉토리로 이동합니다. 해당 디렉토리에서 압축을 푼 뒤 README.md 파일을 열어보면 자동으로 생성된 문서를 확인할 수 있습니다.

결론

Poetry를 사용하면 파이썬 패키지의 문서화를 손쉽게 자동으로 생성할 수 있습니다. pyproject.toml 파일에 설정을 추가한 뒤 poetry build 명령어를 실행하면 자동으로 Markdown 파일이 생성되며, 이를 통해 패키지의 사용법이나 API 문서 등을 쉽게 확인할 수 있습니다. Poetry를 활용하여 더욱 효율적인 문서화를 진행해 보세요.

참고 자료

• Poetry 공식 문서: https://python-poetry.org/docs/
• Markdown 문서 작성 가이드: https://www.markdownguide.org/basic-syntax/