3

Numpy プロジェクトは、読みやすさと自動抽出をサポートするために、ドキュメントのフォーマットの仕様を提供しています (リンク)。また、いくつかの追加キーワードの抽出をサポートするために、Sphinx の拡張機能としてNumpydocも提供しています。

docutils の拡張機能を書き始める前に、既存の docstring をイントロスペクトし、Numpy 標準への非準拠を特定するのに役立つライブラリが存在しますか?

Numpy ドキュメンテーション仕様を採用したい広範なドキュメンテーションを備えた、より成熟したライブラリをイメージします。1 つのアプローチは、ライブラリをイントロスペクトし、ドキュメント文字列の状態を説明するレポートを生成することです。

これは、docutils または numpydoc の拡張としてこれを実装する前の偵察用の質問です。既存のソリューションを見逃していませんか、それとも洗練されたソリューションは存在しますか?

4

1 に答える 1