Python sphinx 在sphinx autodoc的文档字符串中包含模块概要

Python sphinx 在sphinx autodoc的文档字符串中包含模块概要,python-sphinx,autodoc,Python Sphinx,Autodoc,我使用Sphinxautodoc从源代码中的docstring生成python模块的文档。我知道我可以在automodule指令中包含一个:概要:,但这样做违背了使用autodoc的目的,即将所有文档放入docstring中 因此,我尝试将模块指令添加到文件中,如下所示: .. module:: MyModule :platform: Unix, Windows :synopsis: A simple module to provide frobnication function

我使用Sphinx
autodoc
从源代码中的docstring生成python模块的文档。我知道我可以在
automodule
指令中包含一个
:概要:
,但这样做违背了使用
autodoc
的目的,即将所有文档放入docstring中

因此,我尝试将
模块
指令添加到文件中,如下所示:

.. module:: MyModule
    :platform: Unix, Windows
    :synopsis: A simple module to provide frobnication functions.
但是我得到了一个关于重复模块的“严重”警告,因为我正在声明它,而
autodoc
也在声明它。此外,这样做也有点违背了使用
autodoc
的目的,因为我必须指定模块名,而不是让
autodoc
从文件名中找出它(没什么大不了的,但是如果我决定更改模块名,我也需要在这里更改它)

我希望我可以使用类似于
moduleauthor
指令的东西,比如
modulesynopsis
或者仅仅是
synopsis
指令,但是斯芬克斯似乎不认识这两个指令中的任何一个

有人知道在使用
autodoc
时,是否可以在文档字符串中包含摘要吗?

类似于