3

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

所以我尝试向module文件中添加一个指令,如下所示:

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

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

我希望我可以为此使用类似于moduleauthor指令的东西,比如modulesynopsissynopsis单独作为指令,但 Sphinx 似乎无法识别其中任何一个。

有谁知道使用时是否可以在文档字符串中包含概要autodoc

4

0 回答 0