sphinx，restructuredtext：为单个单词设置颜色

Question

有没有办法设置sphinx中单个单词（或字符）的颜色？我很确定应该有一些标记标签，比如 HTML 的 font 标签。

Answer 1

这可行，但将 HTML 留在单独的段落中。

.. raw:: html

    <font color="blue">Blue word,</font>

And a word without color

如果有人有更好的答案，我会接受。

Answer 2

如果您想在不依赖 html 的情况下执行此操作，请尝试将与正常正文文本不同的样式应用于您的单词。

在这个改编自 rst2pdf 手册的示例中，我在我正在使用的后端应用了现有的红色规则样式：

Before red.

.. role:: rubric

I like color :rubric:`rubric`.

After red.

单词的实际外观将取决于您选择的样式在生成文档时使用的样式表中的定义方式。 如果您想要蓝色文本，请制作蓝色文本样式并从普通文本样式派生它。 样式表是特定于后端的，您可能正在使用默认值。 要打印 rst2pdf.py 的默认值，请执行以下操作（来自 rst2pdf 手册）：

rst2pdf --print-stylesheet

继续 rst2pdf 样式表的示例，将其添加到您的样式表以具有蓝色文本样式：

bluetext:
  parent: bodytext
  textColor: blue

在文档中你可以参考这个样式来得到一个蓝色的字。 请注意，此位是通用的，如果您在 html 或任何后端的样式表中定义蓝色样式，则应该生成蓝色文本。

Before blue.

.. role:: bluetext

I like color :bluetext:`blue`.

After blue.

生成的 pdf 带有彩色文字：

Answer 3

在我的 Sphinx 驱动的 website 上，我使用了以下组合：

• 包含角色定义的重组文本文件，每种颜色一个 - 请参阅 .special.rst（BitBucket 链接）
• 包含每个角色的颜色规则的 CSS 文件 - 请参见 hacks.css 的第一行（BitBucket 链接）

然后，在我需要颜色的每个 rST 文件中，我首先在顶部导入 .special.rst，或者手动：

.. include:: .special.rst

或者使用 Sphinx 的 conf.py 文件中的 rst_epilog 配置变量：

rst_epilog = "\n.. include:: .special.rst\n"

然后每个角色都可以在纯 rST 语法中轻松使用：

This is :red:`red !` And :blue:`this part is blue`.

更多详情请见this page（法语，抱歉）。

它非常适用于 html 输出（和类似 html），但不适用于 PDF。请参阅first answer above 以生成带颜色的 PDF。

Answer 4

只是一个简短的说明，因为我登陆这里为 html 寻找类似的东西。

这适用于我的 Sphinx v2.0.1。这使用了@adam-matan 报告的概念，但不会导致任何格式问题（即段落问题）。

参考：reStructuredText Directives

.. role:: raw-html(raw)
   :format: html

:raw-html:`<font color="blue">Blue word,</font>` And a word without color

Answer 5

Sphinx已经支持颜色，s5defs.txt standard definition file 用于 inclusion（但缺少 CSS 文件）：

1. 将此文本创建/附加到rst_epilog 的值 sphinx 配置，在您的docs/conf.py 文件中：

    rst_prolog = """
    .. include:: <s5defs.txt>
   
    """
   

2. 关注 Sphinx's instructions 添加带有颜色的 css （例如采用@Næreen's answer中的hack.css）：

• 将您的 css 文件放入例如_static/css/s4defs-roles.css;

• 将其路径附加到shtml_css_files sphinx 配置中：

      html_css_files = ['css/s4defs-roles.css']
  

然后您可以使用：

Some :red:`colored text` at last!

提示： 如果您还希望样式出现在 Latex 输出中，请阅读 this SO。