Python 如何配置读取文档以使用sphinx autodoc注释？

我正在使用读取Python代码中的函数注释，并使用它生成适当的预期参数类型和返回类型。它在我的本地机器上运行得很好，但我必须

安装sphinx autodoc annotation

我试图使用生成相同的文档，但它给了我一个错误：

Could not import extension sphinx_autodoc_annotation (exception: No module named sphinx_autodoc_annotation)

是否可以将Read the Docs配置为与sphinx autodoc annotation一起使用？如果可以，如何使其工作？

为Read the Docs项目激活安装项目选项

如果该选项被激活，Read Docs将尝试在您的软件包上执行

setup.py install

（请参阅：）。在

setup.py

中，您可以按照中的指定安装软件包。 请看一个例子

---

将

sphinx autodoc annotation

作为您的

requirements.txt

文件的唯一要求添加。

我不喜欢通过

setup.py

打包一大堆文档要求，因此我建议不要在RTD上使用安装项目选项。相反，我更喜欢在我的

doc/

文件夹中放置一个自定义

requirements.txt

，并指向它：

将

setup.py

的

install\u requires

和/或

requirements.txt

中的所有内容粘贴到此文件中。确保您正在使用的任何其他sphinx扩展也在其中

这应该考虑到您的所有依赖关系。我推荐的其他有趣设置如下所示：

---

这很接近，但尚未完全起作用。我将

requirements.txt

添加到

docs

文件夹（因为它只需要构建文档，而不是项目本身），指向RtD设置中的设置，打开“使用setup.py安装在virtualenv中安装您的项目”。我没有发现错误，但现在它无法创建

py modindex.html

文件，当我在本地运行Sphinx时，它会创建该文件。我想我需要把所有这些额外的细节都贴在这个问题上。