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 。