如何将Read the Docs配置为使用sphinx-audoco-Annotation？ [英] How do I configure Read the Docs to use sphinx-autodoc-annotation?

问题描述

我使用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)

是否可以将Read the Docs配置为使用sphinx-AutoDoc-Annotation，如果可以，我如何使其工作？

RTD

我不喜欢通过setup.py打包一大堆文档需求，因此我建议不要在推荐答案上使用安装项目选项。相反，我更喜欢在doc/文件夹中放置一个自定义requirements.txt，并将RTD指向它：

将setup.py的install_requires和/或requirements.txt中的所有内容粘贴到此文件中。确保您正在使用的任何其他狮身人面像扩展名也在其中。

这应该会照顾到您的所有依赖项。我推荐的其他有趣的设置如下所示：

这篇关于如何将Read the Docs配置为使用sphinx-audoco-Annotation？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！