Question

我对使用autodoc的Sphinx自动生成的文档有点麻烦。我基本上遇到与此问题相同的问题：Python Sphinx autodoc and decorated members

当我在函数上使用装饰器时，文档中显示的签名是装饰器的签名。在上述线程的介绍之后，我将@decorator装饰器放在我的装饰器定义上，它确实解决了这个问题。

现在我把我的项目挂钩到了ReadTheDoc.org，它工作得非常好，唯一的问题就是装饰器问题不再适用于以前的修复。

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

可能是配置吗？我使用Python3构建doc

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

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

由于

Answer 1

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

当RTD使用sphinx时，肯定包括sphinx==1.6.5。该版本可能与您的版本有所不同。