".. substitutions" rst 文件中是什么意思?



我有一个README.rst文件,我用Sphinx渲染。在该.rst文件中,我在末尾看到以下两行:

.. substitutions
.. |banner| image:: docs/source/logo/Banner.png

我试图找出短语.. substitutions是什么意思,但我没有找到任何东西。

如果我删除.. substitutions行,sphinx命令给出一个警告

Problem with "end-before" option of "include" directive:
Text not found.

,页面不呈现

有什么想法在哪里找到适当的文档对该指令,和这个错误信息意味着什么?

谷歌搜索没有帮助。对于错误消息,我只发现了3个(!)提示。

在这两行

.. substitutions
.. |banner| image:: docs/source/logo/Banner.png

第一行只是一个注释。

的评论可以在显式标记开始后的行上使用任意缩进文本。为了确保没有其他显式标记结构被识别,请留下&;…&;

但是第二行不是注释,它必须在缩进块内。

+-------+----------------------+
| ".. " | comment              |
+-------+ block                |
|                      |
+----------------------+

话虽如此,你正在使用一个.. include::指令在你的reST的某个地方,显然使用end-before选项。通过删除.. substitutions注释,您可能删除了end-before选项中使用的文本。请看这个精彩的回答。

指令类型:"include"- reStructuredText指令。

end-before:在外部数据文件中查找的文本只包含在指定文本第一次出现之前的内容(但在任何after文本之后)。

相关内容

  • 没有找到相关文章

最新更新