Sphinx+reStructuredText:条件文本的使用

在制作复杂的技术文档过程中,经常会碰到同一内容在不同的发布场景、不同用户角色、不同产品配置的情况下存在差异的情况,此时,借助reStructuredText
only指令和Sphinx指定 tag 输出的功能,可以在 sphinx-build 自动发布文档的过程中,只发布特定版本的文档。
本文主要分享笔者使用 Sphinx + reStructuredText 制作技术文档过程中,条件文本的使用经验。

reST only + tag = 指定内容发布 (tagged content)

only 指令是reStructuredText指令(Directive)之一,即指令生效范围内的内容仅在指定的逻辑表达式为真时才会包含在最后的文档中。

only 指令的语法如下:

.. only:: <expression>

在上述逻辑表达式中,必须包含已定义好的标签(tag),表达式支持 布尔运算,并且支持 括号 的使用,以定义更为复杂的发布条件。例如:逻辑表达式可以为:html 或者 tag_A and (tag_B or tag_C)

only 指令只能用于控制文档的内容,对于标题级、文档内的ID定义(reST文档中称为 label)无效。

其中,对于标签 ( tag)的使用,需注意以下几点:

  • Sphinx-build 默认的发布引擎对应的文件格式和名称可作为预定义的标签,无需额外定义,可直接使用。包括 htmllatexepub 等。

  • 如需自定义标签 (tag),可以在 conf.py 文件中自行添加。

  • 自定义 tag 时,写法需满足 Python 标识符的写法,即 tag 仅能由大小写字母、下划线(且第一个字符不能为下划线)和数字组成。
    详细可以参考https://docs.python.org/3/reference/lexical_analysis.html#identifiers

下面就来介绍具体的用法和操作。

Step 1: 在 conf.py 文件中自定义 tag

除 sphinx-build 默认预定义tag外,用于 only 指令表达式中的 tag 必须先定义才能使用。

  1. 在Sphinx的发布环境文件夹中(默认为 source 文件夹)找到 conf.py 文件。
  2. 在文件中添加以下代码:
tags.has('tag_product_X')

建议统一以 “tag_” 开头设置,这样便于后期在文档中全局搜索标签。

conf.py 文件中定义 tag.png

Step 2: 在文档中使用 only 指定内容发布条件

在 reStructuredText 文件中,对于存在差异的内容,使用 only 指令,指定其发布条件。

.. only:: tag_product_X

   The following content will only be shown in the documents for product X.

Step 3: 指定 tag 发布

使用 sphinx-build 命令发布文档:

sphinx-build [options] <sourcedir> <outputdir> [filenames …] -t tag_product_X

以默认环境下发布PDF为例,发布product X的文档:

sphinx-build -M latexpdf source build -t tag_product_X

此外,也可以自行修改Makefile文件,将 -t 添加至 sphinx-build 命令中,仍然使用 make 命令即可以运行条件发布。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,012评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,628评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,653评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,485评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,574评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,590评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,596评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,340评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,794评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,102评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,276评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,940评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,583评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,201评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,441评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,173评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,136评论 2 352

推荐阅读更多精彩内容