狮身人面像:让课程出现在TOC上

Question

我开始使用ext.autodoc记录一些python类.我有几个带有内容的*.rst文件

========
mymodule
========

.. automodule:: mymodule
   .. autoclass:: myclassA
       :members:
   .. autoclass:: myclassB
       :members:

加上一个index.rst:

.. toctree::
   :maxdepth: 2
   mymodule

'mymodule'显示在目录中,但我也想看看TOC中的类:

我如何让sphinx为每个类创建一个类似的部分？或者有充分的理由不这样做吗？

谢谢

Answer 1

Sphinx 无法创建部分。您必须自己将它们添加到 .rst 文件中。像这样的东西：

myclassA
--------

.. autoclass:: myclassA
   :members:

myclassB
--------

.. autoclass:: myclassB
   :members:

有关一些可能有趣的替代建议，请参阅以下问题（及其答案）：