numpydoc

    0

    1答えて

    私はNumPyDocスタイルのdocstringsを使ってPythonパッケージをドキュメント化しています。私は'numpydoc'スフィンクスの拡張子をNapoleonに変更したいと思います。なぜなら、私はdocstringをよりコンパクトで読みやすい方法でフォーマットしているからです。しかし、ドキュメントの一番上にあるクラスのメソッドはリストされていません。これはnumpydocの非常に貴重な

    0

    1答えて

    私はnumpyのドキュメントストリングのガイドラインに従って私のドキュメントストリングを書いています。それから、私はドキュメントを生成するためにsphinxのautodocを使用します。いくつかのドキュメントストリングの中で私はLaTeX式(sphinx.ext.mathjax)を使用しています。 \rは新しい行のような特別な意味を持つようです。次のコマンドがある場合: """ This :ma

    -1

    1答えて

    私はdocstringを素敵なドキュメントページに翻訳するためにsphinx autodocを使用しています。 docstringでは、私はnumpyのdocstringガイドラインに、sphinx napoleon拡張を使っています。私は、次の疑問を抱いている:私は:label:を認識しない """ This is a very important equation which is used

    3

    1答えて

    Sphinx拡張機能NumpyDocを使用すると、ドキュメントが文書化しているコードと自動的に一致するかどうかを自動的に確認する方法はありますか? たとえば、次のドキュメントが原因タイプミスにコードが一致しません: def myfunc(apples, bears): """ Parameters ---------- apples : int The

    6

    1答えて

    私はNumpyのドキュメントを必要とするプロジェクトに取り組んでいます。私のJavaの時代には、Eclipse/IDEAでJavadocの順守をチェックしていたことを覚えています。 Numpyのドキュメントスタイルの順守をチェックする同等品はありますか? 私はPEP257について知っていますが、Numpyのマニュアルについては具体的なチェックがないようです。