pdoc3/pdoc

어떤 프로젝트인가요?

핵심 기능

• 01모듈, 패키지 디렉터리 또는 import 경로에서 HTML 문서를 생성합니다.
• 02Markdown, numpydoc, Google 스타일 docstring을 지원합니다.
• 03PEP 484 및 PEP 526 타입 어노테이션을 처리합니다.
• 04재정의된 클래스 멤버의 docstring을 상속합니다.
• 05참조된 식별자에 자동으로 링크를 연결합니다.
• 06사용자 지정 템플릿과 내장 실시간 미리보기 서버를 지원합니다.

활용 사례

• Python 라이브러리의 API 레퍼런스 문서를 공개합니다.
• 추가 설정 없이 내부 Python 패키지를 둘러볼 수 있는 문서로 생성합니다.
• 문서를 작성하면서 docstring 렌더링 결과를 미리 확인합니다.

빠른 시작

1. 1

   PyPI에서 pdoc3 설치하기

   pip install pdoc3
2. 2

   프로젝트 문서 생성하기

   pdoc your_project

사용 전 알아둘 점

• !PyPI 패키지 이름은 pdoc가 아니라 pdoc3이므로, pdoc3라는 이름으로 설치해야 합니다.
• !AGPL-3.0 라이선스가 적용됩니다. 강한 카피레프트 라이선스이므로 비공개 소스 프로젝트에서의 사용이 제한될 수 있습니다.

포함된 컬렉션

토픽

자주 묻는 질문

pdoc은(는) 무엇인가요?

특별한 설정 없이 모듈, 패키지, docstring에서 Python 3 프로젝트의 API 문서를 자동 생성합니다. pdoc는 Python 프로젝트의 HTML API 문서를 생성하는 명령줄 도구입니다. 모듈 파일, 패키지 디렉터리 또는 import 경로를 지정하면 공개 객체와 해당 docstring 및 타입 어노테이션을 문서로 렌더링합니다.

pdoc은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

pdoc은(는) AGPL-3.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

pdoc은(는) 아직 유지보수되고 있나요?

6개월 이내 업데이트. pdoc의 마지막 커밋은 2026년 8월 15일입니다.

pdoc은(는) 어디에 사용할 수 있나요?

Python 라이브러리의 API 레퍼런스 문서를 공개합니다. 추가 설정 없이 내부 Python 패키지를 둘러볼 수 있는 문서로 생성합니다. 문서를 작성하면서 docstring 렌더링 결과를 미리 확인합니다.

pdoc는 어떻게 설치하나요?

PyPI에서 pdoc3 설치하기: pip install pdoc3 프로젝트 문서 생성하기: pdoc your_project

pdoc은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/pdoc3/pdoc