Sphinx自动模块显示模块名称？

Question

我在文档中使用了.. automodule:: mypath.mymodule。我想要普通模块docstring而没有其他成员信息。出现模块docstring，但没有指示模块的名称，也没有特殊的段落格式。

是否有标准的方法来包含实际模块的名称，并且可能强调特定段落以区别于普通文本？

Answer 1

我会说“标准”的方法是添加一个带有模块名称的标题：

mypath.mymodule
===============

.. automodule:: mypath.mymodule

某些软件包的示例（单击“显示源”以查看reST标记）：

• 芹菜：http://docs.celeryproject.org/en/latest/reference/celery.events.html
• PyMongo：http://api.mongodb.org/python/current/api/bson/index.html
• matplotlib：http://matplotlib.org/api/dates_api.html