Question

我正在使用Sphinx来记录python应用程序，我使用sphinx_build_script -b html <path/to/source> <path/to/build>命令来构建index.html文件。修改文档字符串并再次使用相同的命令时，它会使html内容无法正确更新。

我试图从_modules，_sources和build目录中删除每个索引文件而没有任何运气。

这是生成的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次。

Answer 1

这不是正确的方法。您应该先使用apidoc生成项目。之后添加的所有类/模块应手动添加到文档中，或者再次调用apidoc（如果您已经自定义了最初生成的项目，则不应该这样做）。

例如，以下指令将递归添加一个新模块及其成员：

.. automodule:: foo.bar
   :members:
   :undoc-members:

它不像JavaDoc那样自动化，但在某些情况下，至少对文档有一些控制权更好。

此外，最好使用make html而不是您正在使用的任何内容，因为它会生成一些索引等。我不记得确切，但是当我使用裸 Sphinx脚本执行此操作时，我肯定没有生成某些内容。

Sphinx没有正确更新文档

1 个答案: