Repolode
投稿する
numpy

numpy/numpydoc

NumPy形式のdocstringを解析し、構造化されたAPIドキュメントとして出力するSphinx拡張機能です。

GitHub で見る公式サイト
スター
354
フォーク
184
未解決の Issue
135
最終コミット
6 日前

これは何？

numpydocは、NumPyのドキュメント形式で書かれたdocstringを扱うSphinx拡張機能です。Parameters、Returns、Raises、Examplesなどのセクションを適切に整形されたSphinx出力に変換するため、Pythonプロジェクト全体で一貫したdocstringスタイルを維持できます。

docstringの解析に加えて、np:functionやnp-c:functionなどのコード説明用ディレクティブを追加し、NumPy形式で関数やC APIをドキュメント化できます。プロジェクトに含まれる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リファレンスを生成する。
  • np-cディレクティブを使い、Python APIとあわせて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リファレンスを生成する。 np-cディレクティブを使い、Python APIとあわせてC拡張関数をドキュメント化する。
numpydoc はどこで入手できますか？
ソースコードとインストール手順は GitHub にあります：https://github.com/numpy/numpydoc

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト