3

我正在尝试让 Read the Docs 生成py-modindex.html文件。对这个问题的研究引导我进行以下设置：

  • setup.py在项目目录中有以下内容，这是开始工作所需的最低限度，pytest并且自从我的项目的那部分工作以来没有改变：

    import setuptools

setuptools.setup(
    name='polygons',
    packages=setuptools.find_packages(),
)

  • docs/requirements.txt包含一行：

    sphinx-autodoc-annotation

  • 阅读文档存储库 URL 指向我的GitHub存储库。

  • 检查“使用 setup.py install 在 vi​​rtualenv 中安装项目”的 RtD 设置。
  • “需求文件”的 RtD 设置指向docs/requirements.txt.

“模块索引”链接包含在 中index.html，但该py-modindex.html文件丢失。

我的理解是，通过上面的 virtualenv 设置，RtD 将使用该setup.py文件来安装项目，以便 Sphinx 可以读取 Python 文档字符串中的文档。我正在使用函数注释，并希望sphyinx-autodoc-annotation在创建构建的文档文件时使用它们。make html当我在docs文件夹中运行时，所有这些都在我的本地机器上运行得非常好。现在我正试图让它在 Read the Docs 上工作。

注意：这是一个练习，我在将其应用到我的实际项目之前要了解所有内容，多边形项目是一个占位符。

4

0 回答 0