tox-dev/sphinx-autodoc-typehints

これは何？

主な機能

• 01コード内の型ヒントをautodocの引数・戻り値フィールドに反映します。
• 02型を構成する各要素から、そのドキュメントへリンクします。
• 03TYPE_CHECKING内でインポートされた名前や、.pyiスタブで宣言された名前を解決します。
• 04@overloadのバリアントやデフォルト値をドキュメント化します。
• 05**kwargs: Unpack[...] を通じて、TypedDictからキーワード引数の型を取得します。
• 06Google形式、NumPy形式、napoleon、numpydocのdocstringスタイルに対応します。

ユースケース

• Sphinx autodocで構築した、型ヒント付きPythonライブラリのドキュメント化。
• 型注釈のないC拡張について、.pyiスタブの型を表示する。
• docstringに型を重複して書かず、APIドキュメントを型注釈と同期させる。

クイックスタート

1. 1

   PyPIから拡張機能をインストールします

   pip install sphinx-autodoc-typehints
2. 2

   sphinx.ext.autodocの後に拡張機能をconf.pyに追加します

収録されている特集

トピック

よくある質問

sphinx-autodoc-typehints とは？

Pythonの型ヒントをautodocの引数・戻り値フィールドに反映し、型へのリンクやスタブファイルにも対応する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スタブの型を表示する。 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