2

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

# my example happens to be a dataclass, but the behavior for 
# regular classes is the same
@dataclass
class TestClass:
    """This is a test class for dataclasses.

    This is the body of the docstring description.
    """
    var_int: int
    var_str: str

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

ドキュメントにはdocstringのみが表示されます

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

ドキュメンテーションは、docstring にあるかのようにクラス変数を表示します

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


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

4

1 に答える 1