2

我正在使用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,如果可以,我该如何使其工作?

4

2 回答 2

2

我不喜欢通过 打包一堆文档要求setup.py,所以我的建议是不要在 RTD 上使用Install Project选项。相反,我更喜欢requirements.txt在我的doc/文件夹中放置一个自定义,并将 RTD 指向它:

在此处输入图像描述

将您在setup.py'sinstall_requires和/或此文件中的任何内容粘贴requirements.txt到此文件中。确保您正在使用的任何其他 sphinx 扩展也在其中。

这应该照顾你所有的依赖。我推荐的其他有趣设置如下所示:

在此处输入图像描述

于 2019-04-02T15:45:41.703 回答
1

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

如果该选项被激活,Read the Docs 将尝试setup.py install在您的包上执行(参见:RtD docs)。在您的需求文件setup.py中,您可以安装软件包。查看Flask-MongoRest 项目的源代码作为示例。

添加sphinx-autodoc-annotationrequirements.txt文件的唯一要求。

于 2016-08-28T09:39:27.583 回答