我想使用 readthedocs.org 为我的项目生成文档(包括使用 autodoc 自动生成的文档)。但是,我的项目使用 Python 3.5 语法( async
和 await
),它看起来无法处理。构建成功,尽管我遇到了很多这样的错误:
/home/docs/checkouts/readthedocs.org/user_builds/sparrow/checkouts/latest/docs/source/entity.rst:176: WARNING: autodoc: failed to import module 'sparrow.entity'; the following exception was raised:
Traceback (most recent call last):
File "/home/docs/checkouts/readthedocs.org/user_builds/sparrow/envs/latest/local/lib/python3.4/site-packages/sphinx/ext/autodoc.py", line 385, in import_object
__import__(self.modname)
File "/home/docs/checkouts/readthedocs.org/user_builds/sparrow/checkouts/latest/sparrow/__init__.py", line 26, in <module>
from .model import *
File "/home/docs/checkouts/readthedocs.org/user_builds/sparrow/checkouts/latest/sparrow/model.py", line 37
async def install(self):
有没有办法解决这个问题?
最佳答案
其他答案有点过时了,因为现在 Readthedocs.org 确实支持 Python 3.5 和 3.6。要使用它,必须配置 readthedocs.yml
。可以在此处找到有关此的文档: http://docs.readthedocs.io/en/latest/yaml-config.html 。
使 Readthedocs.org 使用 Python 3.5 的最小示例是:
build:
image: latest
python:
version: 3.5
如果您有任何依赖项,可以通过
requirements.txt
文件或通过 setup.py
处理。例如,如果您想使用 setup.py
,您只需告诉 Readthedocs.org 安装您的软件包:build:
image: latest
python:
version: 3.5
setup_py_install: true
关于python - 如何在 readthedocs 结合 autodoc 中使用 Python 3.5 语法?,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/36143501/