热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

sphinx,restructuredtext:为单个单词设置颜色-sphinx,restructuredtext:setcolorforasingleword

Isthereawaytosetthecolorofsinglewords(orcharacters)insphinx?Imprettysuretheresho

Is there a way to set the color of single words (or characters) in sphinx? I'm pretty sure there should be some markup tag, like HTML's font tag.

有没有办法在sphinx中设置单个单词(或字符)的颜色?我很确定应该有一些标记标记,比如HTML的字体标记。

3 个解决方案

#1


10  

If you want to do this without being tied to html, try applying a different style than normal body text to your word.

如果你想这样做而不依赖于html,尝试将不同于普通正文文本的样式应用到你的单词中。

In this example adapted from the rst2pdf manual, I apply the existing rubric style which is red in the backend that I am using:

在这个改编自rst2pdf手册的例子中,我应用了我正在使用的后端红色的现有量规样式:

Before red.

.. role:: rubric

I like color :rubric:`rubric`.

After red.

The actual look of the word will depend on how the style you choose is defined in the stylesheet that you use when generating your document. If you want blue text, make a blue text style and derive it from the normal text style. The stylsheet is backend-specific and you may be using the default. To print the default for rst2pdf.py, do this (from the rst2pdf manual):

该单词的实际外观取决于您在生成文档时使用的样式表中如何定义所选样式。如果您想要蓝色文本,请创建蓝色文本样式并从普通文本样式派生。样式表是特定于后端的,您可能正在使用默认值。要打印rst2pdf.py的默认值,请执行此操作(从rst2pdf手册):

rst2pdf --print-stylesheet

Continuing the example for a rst2pdf stylesheet, add this to your stylesheet to have a blue text style:

继续使用rst2pdf样式表的示例,将其添加到样式表以使其具有蓝色文本样式:

bluetext:
  parent: bodytext
  textColor: blue

In the document you can reference this style to get a blue word. Note this bit is generic, and should make blue text if you define a blue style in your html or whatever backend's stylesheet.

在文档中,您可以引用此样式以获得蓝色单词。请注意,这个位是通用的,如果在html或后端的样式表中定义蓝色样式,则应该生成蓝色文本。

Before blue.

.. role:: bluetext

I like color :bluetext:`blue`.

After blue.

The generated pdf has the coloured words: enter image description here

生成的pdf具有彩色字:

#2


8  

On my Sphinx-powered website, I use a combination of:

在我的Sphinx驱动的网站上,我使用了以下组合:

  • A restructuredText file containing roles definitions, one for each color - see .special.rst (BitBucket link)
  • 包含角色定义的restructuredText文件,每种颜色一个 - 请参阅.special.rst(BitBucket链接)
  • A CSS file containing color rules for each role - see the first lines of hacks.css (BitBucket link)
  • 包含每个角色的颜色规则的CSS文件 - 请参阅hacks.css的第一行(BitBucket链接)

Then, in every rST file where I need colors, I first import .special.rst at the top, either manually:

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

.. include:: .special.rst

Or with the rst_epilog configuration variable in Sphinx's conf.py file:

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

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

And then each role can be used easily in pure rST syntax:

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

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

More details are given on this page (in French, sorry).

此页面上提供了更多详细信息(法语,抱歉)。

It works perfectly well for html output (and html-like), but not for PDF. Refer to the first answer above for producing a PDF with colors.

它非常适合html输出(和类似html),但不适用于PDF。有关生成带颜色的PDF,请参阅上面的第一个答案。

#3


6  

This works, but leaves the HTML in a separate paragraph.

这有效,但将HTML留在单独的段落中。

.. raw:: html

    Blue word,

And a word without color

If anyone has a better answer, I will accept it.

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


推荐阅读
  • 本文介绍了Python语言程序设计中文件和数据格式化的操作,包括使用np.savetext保存文本文件,对文本文件和二进制文件进行统一的操作步骤,以及使用Numpy模块进行数据可视化编程的指南。同时还提供了一些关于Python的测试题。 ... [详细]
  • 向QTextEdit拖放文件的方法及实现步骤
    本文介绍了在使用QTextEdit时如何实现拖放文件的功能,包括相关的方法和实现步骤。通过重写dragEnterEvent和dropEvent函数,并结合QMimeData和QUrl等类,可以轻松实现向QTextEdit拖放文件的功能。详细的代码实现和说明可以参考本文提供的示例代码。 ... [详细]
  • Linux重启网络命令实例及关机和重启示例教程
    本文介绍了Linux系统中重启网络命令的实例,以及使用不同方式关机和重启系统的示例教程。包括使用图形界面和控制台访问系统的方法,以及使用shutdown命令进行系统关机和重启的句法和用法。 ... [详细]
  • 展开全部下面的代码是创建一个立方体Thisexamplescreatesanddisplaysasimplebox.#Thefirstlineloadstheinit_disp ... [详细]
  • This article discusses the efficiency of using char str[] and char *str and whether there is any reason to prefer one over the other. It explains the difference between the two and provides an example to illustrate their usage. ... [详细]
  • 本文介绍了利用ARMA模型对平稳非白噪声序列进行建模的步骤及代码实现。首先对观察值序列进行样本自相关系数和样本偏自相关系数的计算,然后根据这些系数的性质选择适当的ARMA模型进行拟合,并估计模型中的位置参数。接着进行模型的有效性检验,如果不通过则重新选择模型再拟合,如果通过则进行模型优化。最后利用拟合模型预测序列的未来走势。文章还介绍了绘制时序图、平稳性检验、白噪声检验、确定ARMA阶数和预测未来走势的代码实现。 ... [详细]
  • Introduction(简介)Forbeingapowerfulobject-orientedprogramminglanguage,Cisuseda ... [详细]
  • 微软头条实习生分享深度学习自学指南
    本文介绍了一位微软头条实习生自学深度学习的经验分享,包括学习资源推荐、重要基础知识的学习要点等。作者强调了学好Python和数学基础的重要性,并提供了一些建议。 ... [详细]
  • 本文介绍了一种划分和计数油田地块的方法。根据给定的条件,通过遍历和DFS算法,将符合条件的地块标记为不符合条件的地块,并进行计数。同时,还介绍了如何判断点是否在给定范围内的方法。 ... [详细]
  • Python正则表达式学习记录及常用方法
    本文记录了学习Python正则表达式的过程,介绍了re模块的常用方法re.search,并解释了rawstring的作用。正则表达式是一种方便检查字符串匹配模式的工具,通过本文的学习可以掌握Python中使用正则表达式的基本方法。 ... [详细]
  • CF:3D City Model(小思维)问题解析和代码实现
    本文通过解析CF:3D City Model问题,介绍了问题的背景和要求,并给出了相应的代码实现。该问题涉及到在一个矩形的网格上建造城市的情景,每个网格单元可以作为建筑的基础,建筑由多个立方体叠加而成。文章详细讲解了问题的解决思路,并给出了相应的代码实现供读者参考。 ... [详细]
  • C++字符字符串处理及字符集编码方案
    本文介绍了C++中字符字符串处理的问题,并详细解释了字符集编码方案,包括UNICODE、Windows apps采用的UTF-16编码、ASCII、SBCS和DBCS编码方案。同时说明了ANSI C标准和Windows中的字符/字符串数据类型实现。文章还提到了在编译时需要定义UNICODE宏以支持unicode编码,否则将使用windows code page编译。最后,给出了相关的头文件和数据类型定义。 ... [详细]
  • 本文介绍了机器学习手册中关于日期和时区操作的重要性以及其在实际应用中的作用。文章以一个故事为背景,描述了学童们面对老先生的教导时的反应,以及上官如在这个过程中的表现。同时,文章也提到了顾慎为对上官如的恨意以及他们之间的矛盾源于早年的结局。最后,文章强调了日期和时区操作在机器学习中的重要性,并指出了其在实际应用中的作用和意义。 ... [详细]
  • [转载]从零开始学习OpenGL ES之四 – 光效
    继续我们的iPhoneOpenGLES之旅,我们将讨论光效。目前,我们没有加入任何光效。幸运的是,OpenGL在没有设置光效的情况下仍然可 ... [详细]
  • python是一门简单灵动的语言。从今天开始我要每天都做笔记,每天都要写博客记录我所想,我所学到的。笔记提纲:1,pyt ... [详细]
author-avatar
我是阿冫轶
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有