如何配置讀取文檔以使用sphinx-autodoc註釋？

Question

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

是否有可能配置閱讀文檔與獅身人面像，車博士的註釋工作，如果是這樣，我如何使它工作？

Answer 1

激活安裝項目選項用於讀取文檔項目。

如果激活該選項，則讀取文檔將嘗試在您的包裝上執行setup.py install（請參閱：RtD docs）。在setup.py中，您可以按照您的requirements file中的指定安裝軟件包。 查看source code of the Flask-MongoRest project的例子。

將sphinx-autodoc-annotation添加爲您的requirements.txt文件的唯一要求。