gpt4 book ai didi

python - 阅读文档 autodoc 似乎在 Python 3.6 格式的字符串上失败

转载 作者:行者123 更新时间:2023-12-01 09:18:15 25 4
gpt4 key购买 nike

我正在使用 Sphinx autodoc 功能为我的 Python 项目制作文档。在本地构建 HTML 工作正常,但在 Read The Docs 上似乎失败了。我已将 RTD 连接到我的 Github 帐户,并带有提交 Hook 。它似乎正在读取我的代码并导入包就好了。

我看到的错误似乎表明它因我的 Python 代码中的格式化字符串而失败:

WARNING: autodoc: failed to import module 'letterboxd.api'; the following exception was raised:
Traceback (most recent call last):
...
File "/home/docs/checkouts/readthedocs.org/user_builds/letterboxd/envs/latest/lib/python3.5/site-packages/letterboxd-0.1.0a5-py3.5.egg/letterboxd/api.py", line 77
headers["Authorization"] = f"Bearer {self.user.token}"
^
SyntaxError: invalid syntax

我在本地运行 Python 3.6,所以我猜测问题可能是阅读文档尚不支持 3.6。我确实将 RTD 管理 > 高级设置 > Python 解释器设置为 CPython 3.x,并且还选中了“使用 setup.py install 在 vi​​rtualenv 中安装项目”框

这是目前 RTD 的一个已知问题,还是我可以调整一些设置来纠正这个问题?

最佳答案

基于bug link @sehafoc 在上面的评论中提供了(谢谢!),我阅读并点击找到 this doc page关于为 RTD 构建 YAML 配置文件。

添加此配置文件解决了此问题,其中 build:image:python:version: 是相关位:

# .readthedocs.yml

build:
image: latest

python:
version: 3.6
setup_py_install: true

requirements_file: requirements.txt

关于python - 阅读文档 autodoc 似乎在 Python 3.6 格式的字符串上失败,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/51032135/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com