如何在 python-sphinx 中突出显示文本？

Question

我正在寻找一种在 python sphinx 中突出显示文本的方法。 我看过有关如何更改单个单词的字体颜色的文档，但我想更改单个单词的背景颜色。

Answer 1

Sphinx已经支持突出显示的文本，其中 s5defs.txt standard definition file 用于 inclusion（但缺少 CSS 文件）：

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

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

2. 关注Sphinx's instructions 以添加您喜欢的大纲 CSS：

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

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

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

然后你可以使用：

Some :outline:`outlined text` at last!

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