我正在使用 Sphinx 来记录一个 python 应用程序,我使用了 sphinx_build_script -b html <path/to/source> <path/to/build>
命令构建 index.html 文件。当修改文档字符串并再次使用相同的命令时,它发现 html 内容没有正确更新。
我已经尝试从 _modules、_sources 和构建目录中删除所有索引文件,但没有成功。
这是生成的 html 文件:
Classe de generation de rapport PDF
:param orientation: Orientation en portrait ou paysage.
:param unit: par defaut en mm.
:param format: Format du document pdf (A4, A6, Letter).
这是源代码:
"""Classe de generation de rapport PDF
:param orientation: Orientation en portrait ou paysage.
:type orientation: char.
:param unit: par defaut en mm.
:param format: Format du document pdf (A4, A6, Letter).
THIS IS AN UPDATE
"""
连续多次运行构建命令后,html 文件将更新 1/5 次。
最佳答案
这不是正确的方法。你应该使用 apidoc首先生成项目。之后将添加的所有类/模块都应手动添加到文档中,或者通过再次调用 apidoc
(尽管如果您自定义了最初生成的项目,则不应这样做)。
例如,以下指令将递归地向页面添加一个新模块及其成员:
.. automodule:: foo.bar
:members:
:undoc-members:
它不像 JavaDoc 那样自动,但在某些情况下,至少对文档有一些控制甚至更好。
此外,最好使用 make html
而不是您正在使用的任何内容,因为它会生成一些索引等。我记不太清了,但我敢肯定,当您使用 bare Sphinx 脚本执行此操作时,不会生成某些内容。
关于python - Sphinx 没有正确更新文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24998582/