Sphinx autodoc - 装饰器和 ReadTheDocs

Question

我在使用 autodoc 自动生成 Sphinx 文档时遇到了一些麻烦。 我基本上和这里有同样的问题： Python Sphinx autodoc and modified members

当我在函数上使用装饰器时，文档中显示的签名就是装饰器的签名。 按照上述线程的说明，我将 @decorator 装饰器放在我的装饰器定义中，它确实解决了问题。

现在我已经将我的项目连接到 ReadTheDoc.org 上，它运行良好，唯一的问题是装饰器问题又回来了，而与之前的修复无关。

我对 Sphinx 很陌生，所以我不确定这是否值得在 RTD Github 项目上产生问题。 我可以在这里错过什么？ 在此处查看损坏的签名

会不会是配置？ 我用 Python3 构建文档

另外，如果模块不可用，我定义了一个虚拟的@decorator ，如下所示：

try:
    from decorator import decorator
except ImportError:
    def decorator(f):
        return f

Answer 1

您可以在 RTD 中添加一个requirements.txt文件，在该文件中，您可以指定与本地环境完全相同的环境。

当然包括sphinx作为 RTD 使用sphinx==1.6.5 。 该版本的行为可能与您的不同。

Answer 2

您必须将装饰器指定为包中的依赖项，或者将其添加到 RTD 需求文件requirements.txt 。