如何通过在 python-sphinx 中使用角色来使用唯一的指令内联？答案

【问题标题】：How can I use the only directive inline by using role in python-sphinx?如何通过在 python-sphinx 中使用角色来使用唯一的指令内联？
【发布时间】：2015-06-17 19:59:09
【问题描述】：

在 python-sphinx 中有only directive，可用于根据其输出有条件地影响文档。例如，文本仅出现在 html 或 Latex 中。

它是这样使用的：

.. only:: 不是乳胶这里有一些文本，没有出现在乳胶输出中。 .. 仅:: html 这里有一些文本，只出现在 html 输出中。

如何以正确的方式使用角色指令来使用唯一类内联，让我们这样说：

这里有一些文本，:only-notlatex:`没有出现在latex中`
:only-html:`只出现在html中`。

我在 raw 指令中看到了类似的东西。唯一的指令也可以这样做吗？我试过了：

.. 角色:: only-html(only) :格式: html .. 角色:: only-notlatex(only) ：格式：不是乳胶

但这不起作用。

【问题讨论】：

不要混淆指令和角色。指令适用于文本块（整个段落）；角色用于内联文本（段落内）。没有对应于only 指令的内置角色。为此，您必须创建自己的自定义角色。我无法提供任何详细说明，但这里有一篇文章可以帮助您入门：doughellmann.com/2010/05/09/…。
好的，谢谢。这是有道理的。我很困惑，因为我认为raw 是一个指令，并且为此它有效。但正如here 所说，这似乎是“一种特殊情况”。
我把我的评论变成了正确的答案。

标签： inline python-sphinx restructuredtext role

【解决方案1】：

指令适用于文本块（整个段落）；角色用于内联文本（段落内）。

您提到了raw，确实有一个directive 和一个role 同名，用于“原始数据传递”。

但是没有内置角色是 only 指令的内联等效项。为此，您必须创建自己的自定义角色。我无法提供任何详细说明，但这里有一篇文章可以帮助您入门：http://doughellmann.com/2010/05/09/defining-custom-roles-in-sphinx.html。

【讨论】：