我正在使用Sphinx，非常喜欢它，但是它不会引起模块简介。没有错误或任何东西，只是普通的...什么都没有。这是我要自动记录文档的模块:
# vim: set fileencoding=utf-8 :
"""
.. module:: CONF
:synopsis: Configuration module, tells where data files are.
.. moduleauthor:: Mr Anderson <[email protected]>
"""
这是ReST索引文件中的Sphinx指令:
.. automodule:: CONF
:synopsis:
我从狮身人面像中获得了其他各种奇妙的东西，因此对我而言，它通常不会被破坏。我得到的唯一可疑的东西是:
SEVERE: Duplicate ID: "module-CONF"。一些谷歌搜索使我相信尽管此错误是“正常的”？ 最佳答案
不确定这是否真的回答了您的问题，但是也许您正在寻找错误的地方以使摘要得到理解。 (“错误”，因为期望它出现在automodule指令所在的位置似乎很合理)。从module markup(重点是我的)的文档中:
因此，对于模块注释字符串:
"""
.. module:: CONF
:synopsis: Configuration module, tells where data files are.
continuation possible here... (though goes against the point of synopses...)
:platform: Windows
"""
概要出现在模块索引中-类似
或者，对于模块注释字符串(注释缩进):
"""
:synopsis: Configuration module, tells where data files are to.
"""
将在您放置在
automodule::指令中的位置而不是在模块索引中的位置进行渲染。对我来说，样式就是在成员函数中呈现参数。作为一种令人讨厌的解决方法，您可以结合使用这两个
:synopsis:声明，尽管显然这不太容易维护。关于python - :synopsis: not working in Sphinx automodule，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/14361140/