ml-tooling/lazydocs

어떤 프로젝트인가요?

핵심 기능

• 01Google 스타일 Python docstring에서 Markdown API 문서를 생성합니다.
• 02파일 경로와 줄 번호가 포함된 소스 코드 링크를 만듭니다.
• 03모듈, 클래스, 함수를 나열하는 API 개요 파일을 생성합니다.
• 04MkDocs 사이트 및 GitHub에서 렌더링되는 Markdown과 연동됩니다.
• 05문서 생성 전에 pydocstyle로 docstring을 선택적으로 검증합니다.

활용 사례

• GitHub 저장소와 함께 Python 라이브러리의 API 참조 페이지를 공개합니다.
• MkDocs 문서 사이트에 자동 생성되는 API Reference 섹션을 추가합니다.
• 모듈 작업 중 docstring 기반 문서를 콘솔에 출력합니다.

빠른 시작

1. 1

   PyPI에서 lazydocs를 설치하세요

   pip install lazydocs
2. 2

   Python 패키지의 Markdown 문서를 생성하세요

   lazydocs path/to/your/package

사용 전 알아둘 점

• !Google 스타일의 Python docstring만 지원합니다.

포함된 컬렉션

토픽

자주 묻는 질문

lazydocs은(는) 무엇인가요?

Sphinx보다 가벼운 대안으로, Google 스타일 Python docstring에서 Markdown API 문서를 생성하는 CLI 도구입니다. Lazydocs는 Python 패키지, 모듈 또는 지정한 클래스와 함수를 검사한 뒤 Google 스타일 docstring을 바탕으로 Markdown 문서를 작성합니다. 명령 하나로 CLI에서 실행하거나, Python에서 프로그래밍 방식 API를 통해 호출할 수 있습니다. 기본 출력 위치는 ./docs 폴더이며, stdout으로 출력할 수도 있습니다.

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

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

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

활발히 유지보수 중. lazydocs의 마지막 커밋은 2026년 10월 23일입니다.

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

GitHub 저장소와 함께 Python 라이브러리의 API 참조 페이지를 공개합니다. MkDocs 문서 사이트에 자동 생성되는 API Reference 섹션을 추가합니다. 모듈 작업 중 docstring 기반 문서를 콘솔에 출력합니다.

lazydocs는 어떻게 설치하나요?

PyPI에서 lazydocs를 설치하세요: pip install lazydocs Python 패키지의 Markdown 문서를 생성하세요: lazydocs path/to/your/package

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

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/ml-tooling/lazydocs