Sphinx:如何在模块内部,但在类和方法之外,包含文档字符串/注释

时间:2018-09-14 19:14:36

标签: python-sphinx autodoc

我在python模块中有一条注释,其中记录了随后的几个类,例如

###

# Classes for agents: patients and clinicians

###

class EngagementLadder(transitions.Machine):
    """The state machine for agent states.

实际上,有几个这样的多类注释。每个文件都用于分解文件,并将其组织成相关部分。

我想在生成的文档中看到这些注释,也许是标题。该怎么做?

请注意,我的问题与In Sphinx, how to include docstrings/comments located in a module, but outside of class and methods类似,但是对他有用的答案(将其放在模块docstring中)对我不起作用,因为我希望这些注释在文件的更下方。

0 个答案:

没有答案