Question

我使用sphinx-autodoc-annotation来读取Python代码中的函数注释，并使用它来生成适当的预期参数类型和返回类型。它在我的本地机器上工作得很好，但我当然不得不pip install sphinx-autodoc-annotation。

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

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

是否可以配置阅读文档以使用sphinx-autodoc-annotation，如果可以，我该如何使其工作？

Answer 1

为您的Read the Docs项目激活安装项目选项。

如果该选项已激活，则阅读文档会尝试在您的包装上执行setup.py install（请参阅：RtD docs）。在setup.py中，您可以按照requirements file中的说明安装软件包。请查看source code of the Flask-MongoRest project的示例。

添加sphinx-autodoc-annotation作为requirements.txt文件的唯一要求。

Answer 2

我不喜欢通过setup.py打包大量文档要求，所以我的建议是不要在RTD上使用安装项目选项。相反，我更喜欢在requirements.txt文件夹中放入自定义doc/，然后将RTD指向它：

将setup.py的{{1}}和/或install_requires中的所有内容粘贴到此文件中。确保您正在使用的所有其他狮身人面像扩展都在其中。

那应该照顾您的所有依赖关系。我建议推荐的其他有趣的设置如下：