在课堂中间添加文字

时间:2019-08-21 14:33:56

标签: python-sphinx autodoc

使用Sphinx Autodoc,我有一个类,其方法分为两个明确定义的部分。

在我的文档中,我想:

  1. 介绍班级名称
  2. 描述整个班级
  3. 描述方法的前半部分
  4. 列出方法的前半部分
  5. 描述方法的后半部分
  6. 列出方法的后半部分

但是,autodoc似乎不允许您执行此操作-仅在docstring的最顶部有一个描述块,然后将类的所有方法集中在一起。

如何在不修改实际的Python类(例如将其拆分为2个类)的情况下拆分这些方法并分别描述它们?

0 个答案:

没有答案