問題タブ [sphinx-napoleon]

Sphinxを使用してコードのドキュメントを作成する方法を学んでいます。このような例をいくつか見た後：

Sphinx がコメントを理解してキャッチできるようにするために、コメントで使用される言語は何ですか? この構文とロジックがないと、Sphinx はコード内のコメントを認識せず、HTML を生成するとモジュールが空になります。

ここに例があります：

sphinx 3.1.1 を使用して、napoleon プリプロセッサを使用して画像を挿入したいと考えています。

docstring に ".. image::" というコマンドを含めることで、ナポレオン プリプロセッサによる事前解釈が防止され、docstring は標準の sphinx インタープリターによって解釈されるようです。

画像は正しく視覚化されていますが、パラメーターと戻り値が正しく解釈されず、プレーン テキストのように見えます。

image コマンドを削除すると、期待どおりの解釈が得られます。

誰にも解決策がありますか？

注意: スフィンクス標準の reStructuredText でドキュメントを書きたくありません。

Sphinx がクラス記述をレンダリングする方法の動作に変化があることに気付きました。このコードを考えると

プラスいくつかの一般的な Sphinx 設定、私は約 2 年前にこれを取得するために使用

そして今これを手に入れています

クラス変数をクラス定義の最後に追加しないように Sphinx に指示する方法はありますか? Noneデフォルトがないという理由だけで、それらの値が であると想定するのは特に面倒です。

この問題は、Sphinx の設定などに関するコメントにもう少しコンテキストが含まれているこの投稿のディスカッション中に発生しました。