python - 将其他 html 文档集成到 sphinx 文档中

Question

如何将其他工具生成的 html 文档（例如鼻子、覆盖率和 pylint 报告）包含到 Sphinx 文档中。他们应该进入 _static 目录吗？如果是这样，你如何链接到他们？

我正在尝试将所有代码开发工具文档的简洁包构建为 .pdf 或 html。

Answer 1

我有一个类似的问题，我可以通过执行以下操作来解决它。请注意，这仅适用于 HTML 输出。

1. 使用以下内容创建一个 index.rst 字段：

====================== Javadoc of the API XXX ======================

当我使用扩展名“sphinx.ext.autosectionlabel”时，这将成为“1 级”部分。

2. 修改 Make 文件，一旦生成 HTML，它将“API XXX 的 Javadoc”部分的 index.html 替换为我的 API 的 Javadoc。

在此更改之后，在目录树上，我有一个指向“API XXX 的 Javadoc”的链接，当您单击它时，您会看到 Javadoc。

我知道这不是正确的做法，但这是我经过多次 Google 搜索后得出的唯一方法。