次のような 3 層のクラス構造があります。
class Super(object):
"""This class is documented."""
class Intermediate(Super):
pass
class Sub(Intermediate):
"""This is also documented."""
私のindex.rst
ファイルは次のようになります。
.. automodule:: mymodule
:show-inheritance:
:inherited-members:
Sphinx は、すばらしい API ドキュメントを生成してくれます。これには、クラスSuper
とが含まれSub
、適切なコメントが付けられています。コメントがなく、フラグIntermediate
を提供しなかったため、含まれていません。これは、ドキュメントに表示されundoc-members
たくないためです。Intermediate
私の問題は次のとおりです。show-inheritance
フラグを提供するため、Sphinx は各クラスのベースを表示します。とのobject
ために。文書化されていないため、基本クラスのリストに表示したくありません。代わりに、Sphinx が継承ツリーの次の文書化されたクラスを表示するようにしたいと思います。つまり、Sphinx にの基底クラスとしてではなく、を表示させたいのです。Super
Intermediate
Sub
Intermediate
Super
Super
Intermediate
Sub
誰もこれを行う方法を知っていますか?