python-sphinx - 让类出现在 Sphinx 的 TOC 上

Question

我开始使用 ext.autodoc 记录一些 python 类。我有几个 *.rst 文件，其内容如下

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

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

加上一个 index.rst：

.. toctree::
   :maxdepth: 2
   mymodule

'mymodule' 显示在目录中，但我也想查看目录中的类：

如何让 sphinx 为每个班级创建类似部分的内容？还是有充分的理由不这样做？

谢谢

score 3 · Accepted Answer

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

myclassA
--------

.. autoclass:: myclassA
   :members:

myclassB
--------

.. autoclass:: myclassB
   :members:

对于一些可能有趣的替代建议，请参阅这些问题（和答案）：

1 回答 1