Repolode
제출하기
tox-dev

tox-dev/sphinx-autodoc-typehints

Python 타입 힌트를 autodoc의 매개변수 및 반환값 필드로 옮기고, 링크와 stub을 지원하는 Sphinx 확장입니다.

GitHub에서 보기웹사이트
스타
588
포크
115
열린 이슈
0
마지막 커밋
12시간 전

어떤 프로젝트인가요?

sphinx-autodoc-typehints는 Sphinx autodoc 확장으로, 문서화 대상 Python 코드의 타입 힌트를 읽어 생성된 문서의 매개변수 및 반환값 필드에 기록합니다. 개발자는 docstring에 타입을 반복해서 적는 대신 코드에 한 번만 선언하면 됩니다.

각 타입 구성 요소를 해당 문서에 연결하고, `if TYPE_CHECKING:` 블록 안에서만 import되거나 `.pyi` stub 파일에 선언된 이름도 확인합니다. 또한 `@overload` 변형과 기본값을 문서화하며, napoleon 또는 numpydoc용으로 작성된 Google 및 NumPy 스타일 docstring에 타입을 표시할 수 있습니다.

프로젝트 문서에서는 Sphinx 내장 `autodoc_typehints` 설정과 이 확장을 비교하며, `TypedDict`를 이용한 타입 지정 `**kwargs`, `Annotated[..., Doc(...)]` 설명, `@deprecated` 알림 등의 차이를 보여줍니다.

핵심 기능

  • 01코드의 타입 힌트를 autodoc의 매개변수 및 반환값 필드에 기록합니다.
  • 02각 타입 구성 요소를 해당 문서에 연결합니다.
  • 03TYPE_CHECKING 아래에서 import된 이름과 .pyi stub에 선언된 이름을 확인합니다.
  • 04@overload 변형과 기본값을 문서화합니다.
  • 05**kwargs: Unpack[...]을 통해 TypedDict로 키워드 인수의 타입을 지정합니다.
  • 06Google, NumPy, napoleon 및 numpydoc docstring 스타일을 지원합니다.

활용 사례

  • Sphinx autodoc으로 빌드한 타입 지정 Python 라이브러리를 문서화할 때.
  • 어노테이션이 없는 C 확장에 대해 .pyi stub의 타입을 표시할 때.
  • docstring에 타입을 중복 기재하지 않고 타입 어노테이션과 API 문서를 일치시킬 때.

빠른 시작

  1. 1

    PyPI에서 확장 기능을 설치합니다

    pip install sphinx-autodoc-typehints
  2. 2

    sphinx.ext.autodoc 뒤에 확장 기능을 conf.py에 추가합니다

포함된 컬렉션

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

토픽

#sphinx#python#documentation#type-hints#autodoc#typehints

자주 묻는 질문

sphinx-autodoc-typehints은(는) 무엇인가요?
Python 타입 힌트를 autodoc의 매개변수 및 반환값 필드로 옮기고, 링크와 stub을 지원하는 Sphinx 확장입니다. sphinx-autodoc-typehints는 Sphinx autodoc 확장으로, 문서화 대상 Python 코드의 타입 힌트를 읽어 생성된 문서의 매개변수 및 반환값 필드에 기록합니다. 개발자는 docstring에 타입을 반복해서 적는 대신 코드에 한 번만 선언하면 됩니다.
sphinx-autodoc-typehints은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
sphinx-autodoc-typehints은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
sphinx-autodoc-typehints은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. sphinx-autodoc-typehints의 마지막 커밋은 2026년 11월 6일입니다.
sphinx-autodoc-typehints은(는) 어디에 사용할 수 있나요?
Sphinx autodoc으로 빌드한 타입 지정 Python 라이브러리를 문서화할 때. 어노테이션이 없는 C 확장에 대해 .pyi stub의 타입을 표시할 때. docstring에 타입을 중복 기재하지 않고 타입 어노테이션과 API 문서를 일치시킬 때.
sphinx-autodoc-typehints는 어떻게 설치하나요?
PyPI에서 확장 기능을 설치합니다: pip install sphinx-autodoc-typehints sphinx.ext.autodoc 뒤에 확장 기능을 conf.py에 추가합니다
sphinx-autodoc-typehints은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/tox-dev/sphinx-autodoc-typehints

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

관련 프로젝트