如何在Sphinx中设置扩展的配置值

时间:2018-07-03 19:30:54

标签: python-sphinx restructuredtext

我正在尝试使用here所述的autosectionlabel_prefix_document扩展名中的autosectionlabel配置值。我已将扩展名加载到conf.py中,并且工作正常。目前,我尝试添加以下行:

autosectionlabel_prefix_document = True

发送到conf.py,但它会抛出错误消息:

WARNING: undefined label: shaders:force shaders
(if the link has no caption the label must precede a section header)

在配置扩展程序时我缺少什么吗?该文档将托管在ReadTheDocs上,因此我对扩展本身并没有真正的控制权,无论如何都似乎很草率。

请确保我使用的语法正确,以防出现问题,我正在使用

:ref:`shaders:force shaders`

这应该创建一个名为force shaders的链接,该链接指向文档force shaders中的子标题shaders.rst

相关版本:
Python 2.7
狮身人面像1.7.5
PyCharm 2018.1.4

1 个答案:

答案 0 :(得分:0)

如果shaders.rst不在根目录中,则应在文件名前加上根目录的路径。例如,如果您具有以下布局:

index.rst
/xdir
    main.rst
/ydir
    /zdir
        shaders.rst

然后,您可以将Force Shaders中位于shaders.rst中的标题main.rst称为:ref:`ydir/zdir/shaders:force shaders`。 (对我来说,可以使用sphinx-1.7.5。)