在sphinx autodoc的docstring中包含模块概要

时间:2013-01-17 15:43:00

标签: python-sphinx

我正在使用Sphinx autodoc从源代码中的docstrings生成python模块的文档。我知道我可以在:synopsis:指令中包含automodule,但这种方法违背了使用autodoc的目的,即将所有文档放在文档字符串中。

所以我尝试将module指令添加到文件中,如下所示:

.. module:: MyModule
    :platform: Unix, Windows
    :synopsis: A simple module to provide frobnication functions.

但是后来我得到了关于重复模块的“严重”警告,因为我正在声明它并且autodoc也宣告它。另外,这样做也有点失败了使用autodoc的目的,因为我必须指定模块名称,而不是让autodoc从文件名中找出它(不是很大,但如果我决定更改名称在模块中,我也需要在这里更改它。)

我希望我可以使用类似于moduleauthor指令的东西,例如modulesynopsis或仅synopsis作为指令,但Sphinx似乎也不认识这些。

有人知道在使用autodoc时是否可以在docstring中包含概要?

0 个答案:

没有答案