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