Repolode
제출하기
numpy

numpy/numpydoc

NumPy 스타일 docstring을 파싱해 구조화된 API 문서로 렌더링하는 Sphinx 확장입니다.

GitHub에서 보기웹사이트
스타
354
포크
184
열린 이슈
135
마지막 커밋
6일 전

어떤 프로젝트인가요?

numpydoc은 NumPy 문서 형식으로 작성된 docstring을 처리하는 Sphinx 확장입니다. Parameters, Returns, Raises, Examples 같은 섹션을 형식에 맞는 Sphinx 출력으로 변환하므로, Python 프로젝트 전체에서 일관된 docstring 스타일을 유지할 수 있습니다.

이 확장은 docstring 파싱 외에도 NumPy 스타일로 함수와 C API를 문서화하는 np:function 및 np-c:function 같은 코드 설명 지시문을 제공합니다. 프로젝트에 포함된 NumPy docstring 가이드에서는 확장과 함께 사용할 수 있는 docstring 작성법을 설명합니다.

이 패키지를 사용하려면 Python 3.10 이상과 Sphinx 6 이상이 필요합니다.

핵심 기능

  • 01Parameters, Returns, Raises 같은 NumPy 스타일 docstring 섹션을 파싱합니다.
  • 02코드 객체를 문서화하는 np:function 및 np-c:function 지시문을 추가합니다.
  • 03표준 확장으로 Sphinx와 통합됩니다.

활용 사례

  • NumPy 스타일 docstring을 사용하는 Python 라이브러리의 API 레퍼런스 문서를 생성합니다.
  • Python API와 함께 np-c 지시문을 사용해 C 확장 함수를 문서화합니다.

사용 전 알아둘 점

  • 저장소 메타데이터에서 라이선스를 확인할 수 없습니다. 재사용하기 전에 LICENSE 파일을 확인하세요.

포함된 컬렉션

정적 사이트 생성기 및 문서 도구

토픽

#sphinx#documentation#docstring#python#numpy

자주 묻는 질문

numpydoc은(는) 무엇인가요?
NumPy 스타일 docstring을 파싱해 구조화된 API 문서로 렌더링하는 Sphinx 확장입니다. numpydoc은 NumPy 문서 형식으로 작성된 docstring을 처리하는 Sphinx 확장입니다. Parameters, Returns, Raises, Examples 같은 섹션을 형식에 맞는 Sphinx 출력으로 변환하므로, Python 프로젝트 전체에서 일관된 docstring 스타일을 유지할 수 있습니다.
numpydoc은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
numpydoc은(는) Other 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
numpydoc은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. numpydoc의 마지막 커밋은 2026년 11월 1일입니다.
numpydoc은(는) 어디에 사용할 수 있나요?
NumPy 스타일 docstring을 사용하는 Python 라이브러리의 API 레퍼런스 문서를 생성합니다. Python API와 함께 np-c 지시문을 사용해 C 확장 함수를 문서화합니다.
numpydoc은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/numpy/numpydoc

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트