python - Sphinx automodule 显示模块名称？

Question

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

是否有一种标准方法来包含实际模块的名称，并可能强调该特定段落以将其与普通文本区分开来？

Answer 1

我想说“标准”方法是添加带有模块名称的标题:

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

.. automodule:: mypath.mymodule

一些包中的示例(单击“显示源代码”以查看 reST 标记):

• celery :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