我开始使用ext.autodoc记录一些python类。我有几个* .rst文件包含
等内容========
mymodule
========
.. automodule:: mymodule
.. autoclass:: myclassA
:members:
.. autoclass:: myclassB
:members:
加上index.rst:
.. toctree::
:maxdepth: 2
mymodule
'mymodule'显示在目录中,但我也希望看到TOC中的类:
如何让sphinx为每个类创建一个类似的部分?或者有充分的理由不这样做吗?
感谢
答案 0 :(得分:3)
Sphinx无法创建部分。您必须自己在.rst文件中添加它们。像这样:
myclassA
--------
.. autoclass:: myclassA
:members:
myclassB
--------
.. autoclass:: myclassB
:members:
对于一些可能有趣的替代建议,请参阅以下问题(以及答案):