Python sphinx Readthedocs-需要斯芬克斯2.1+;处理:async:选项的步骤

Python sphinx Readthedocs-需要斯芬克斯2.1+;处理:async:选项的步骤,python-sphinx,read-the-docs,Python Sphinx,Read The Docs,我的第一个公共Python项目现在在readthedocs(RTD)上。我正试图解决一个问题,但迄今为止没有成功 我正在使用:async:选项来标记协同路由。Sphinx2.1+支持这一点。RTD在我的项目中使用了sphinx 1.8.5。所有协同程序都只是从HTML输出中跳过,即根本没有文档记录。那太糟糕了 我在我的项目中创建了docs/requirements.txt文件,其中包含:sphinx>=2.1.0,并在RTD>admin>高级设置中输入:/docs/requirements.tx

我的第一个公共Python项目现在在readthedocs(RTD)上。我正试图解决一个问题,但迄今为止没有成功

我正在使用
:async:
选项来标记协同路由。Sphinx2.1+支持这一点。RTD在我的项目中使用了sphinx 1.8.5。所有协同程序都只是从HTML输出中跳过,即根本没有文档记录。那太糟糕了

我在我的项目中创建了
docs/requirements.txt
文件,其中包含:
sphinx>=2.1.0
,并在RTD>admin>高级设置中输入:
/docs/requirements.txt
作为“构建文档所需的pip需求文件。从项目根目录开始的路径。”。我不知道这是不是正确的方式来指定斯芬克斯版本。反正我试过了

生成失败:

ERROR: Could not open requirements file: [Errno 2] No such file or directory: '../../../../../../../../docs/requirements.txt'

我如何才能克服这些问题,使所有的协同程序都得到正确的记录?

RTD找不到您的需求文件。请删除前导斜杠,尝试指定相对于项目根的路径,而不是绝对路径。

RTD找不到您的需求文件。通过删除前导斜杠,尝试指定相对于项目根的路径,而不是绝对路径。@StevePiercy是的,这很有帮助。非常感谢。我的文档最终看起来应该是这样的。我仍然不完全理解问题的根本原因。“项目根目录的路径。”是最终文件位置的
路径部分
/root/Path
,不是吗?然后,如果一个相对路径给出了
/ROOT/path',则绝对路径应产生等效的
/ROOT//path'。
/
是服务器的根,而不是项目的根。所有以
/
开头的路径都是绝对路径,而不是相对路径
/
是项目的根目录。它是相对于工作目录的。您可以使用前导的
/
或不使用来指定需求文件的位置。感谢您的解释。不知何故,我没有想到路径会被这样使用,因为它可能允许用户项目之外的文件访问。您可以尝试在那里查看,您可能会被拒绝读取或写入它的权限。错误消息没有明确提到权限,但可能就是这样。