时间:2021-07-01 10:21:17 帮助过:49人阅读
本章节介绍 reStructuredText (reST)
的概念和语法,为文档生成者提供足够的信息. reST
被认为是简单,实用的标记语言,因此学习它不会花太多时间.
段落 (ref
段落是由空行分隔的一段文本. 和Python一样, 对齐也是reST的操作符,
因此同一段落的行都是左对齐的.
标准的reST 内联标记相当简单:
星号及反引号在文本中容易与内联标记符号混淆,可使用反斜杠符号转义.
标记需注意的一些限制:
这些限制在未来版本可能会被改善.
reST 也允许自定义 “文本解释角色”‘, 这意味着可以以特定的方式解释文本.
Sphinx以此方式提供语义标记及参考索引,操作符为 :rolename:`content.
标准reST 提供以下规则:
* :durole:emphasis` – 写成 *emphasis** strong – 写成
**strong*** literal – 写成 literal* subscript – 下标 *
superscript – 上标 * title-reference – 书、期刊等材料的标题
详情请查看 inline-markup .
列表标记 (ref
仅在段落的开头放置一个星号和一个缩进. 编号的列表也可以;也可以使用符号
#自动加序号:
* 这是一个项目符号列表.* 它有两项, 第二项使用两行.1. 这是个有序列表.2. 也有两项.#. 是个有序列表.#. 也有两项.
列表可以嵌套,但是需跟父列表使用空行分隔 :
* 这是* 一个列表 * 嵌套列表 * 子项* 父列表继续
定义列表 (ref
术语 (term 文本开头行) 定义术语,必须缩进 可以有多段组成下一术语(term) 描述.
一行仅能写一个术语.
引用段落 (ref
行模块 (ref
| 这些行| 在源文件里| 被分隔的一模一样.
还有其他有用的模块:
字面代码块 (ref
代码块必须缩进(同段落,需要与周围文本以空行分隔):
这是一段正常文本. 下一段是代码文字:: 它不需要特别处理,仅是 缩进就可以了. 它可以有多行.再是正常的文本段.
这个 ::标记很优雅:
因此上面的例子第一段文字将变为”下一段是代码文字:”.
支持两种表格. 一种是 网格表格(ref
+------------------------+------------+----------+----------+| Header row, column 1 | Header 2 | Header 3 | Header 4 || (header rows optional) | | | |+========================+============+==========+==========+| body row 1, column 1 | column 2 | column 3 | column 4 |+------------------------+------------+----------+----------+| body row 2 | ... | ... | |+------------------------+------------+----------+----------+
简单表格(ref
需要有多行,且第一列元素不能分行显示,如下:
===== ===== =======A B A and B===== ===== =======False False FalseTrue False FalseFalse True FalseTrue True True===== ===== =======
使用 `链接文本
链接文本是网址,则不需要特别标记,分析器会自动发现文本里的链接或邮件地址.
可以把链接和标签分开 (ref
段落里包含 `a link`_... _a link: http://example.com/
内部链接是Sphinx特定的reST角色, 查看章节 ref-role.
章节的标题 (ref
=================This is a heading=================
通常没有专门的符号表示标题的等级,但是对于Python 文档,可以这样认为:
当然也可以标记(查看 reST 文档),定义章节的层次,但是需要注意输出格式(HTML, LaTeX)所支持的层次深度 .
显式标记”Explicit markup” (ref
显式标记以 ..开始,后跟空白符,与下面段落的缩进一样.
(在显示标记与正常的段落间需有空行,这听起来有些复杂,但是写起来会非常直观.)
指令 (ref
文档工具支持以下指令:
影响标记:
如果仅有一个文件,最好使用 default_role.
设置不使用指令 sectnum, header 及 footer.
Sphinx 新增指令可查阅 sphinxmarkup.
指令有名字,参数,选项及内容组成.(记住这些,在下面一小节中自定义指令里会用到).来看一个例子:
.. function:: foo(x) foo(y, z) :module: some.module.name 返回用户输入的一行文本.
function是指令名字. 在第一行和第二行给出了两个参数, 及一个选项
module(如你所见,选项在参数后给出,由冒号引出).
选项必须与指令有一样的缩进.
指令的内容在隔开一个空行后,与指令有一样缩进.
reST 支持图像指令 (ref
.. image:: gnu.png (选项)
这里给出的文件名( gnu.png)
必须是源文件的相对路径,如果是绝对路径则以源目录为根目录. 例如,在文件
sketch/spam.rst引用图像 images/spam.png,则使用
../images/spam.png或者 /images/spam.png.
Sphinx 会自动将图像文件拷贝到输出目录的子目录里,( 输出HTML时目录为
_static)
图像的大小选项 ( width及 height) : 如果没有单位或单位为像素,
给定的尺寸信息仅在输出通道支持像素时才有用 ( 如输出LaTeX 没用).
其他单位在输出(如 pt)HTML、LaTeX 时被用到.
Sphinx 延伸了标准的文档化行为,只需在后面加星号:
.. image:: gnu.*
上面这样写,Sphinx 会搜索所有名字匹配的图像,而不管图像类型.
每个生成器则会选择最合适的图像. 一般,在源文件目录里文件名 gnu.*会含有两个文件 gnu.pdf 和 gnu.png , LaTeX 生成器会选择前者,而HTML
生成器则匹配后者.
尾注 (ref
尾注的内容则在文档底部红色标题”Footnotes”的后面 , 如下:
Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_.. rubric:: Footnotes.. [#f1] 第一条尾注的文本... [#f2] 第二条尾注的文本.
你也可以使用数字尾注 ( [1]_) 或使用自动排序的( [#]_).
支持标准的reST 引用 (ref
Lorem ipsum [Ref]_ dolor sit amet... [Ref] 参考文献, 书,URL 等.
引用的使用同尾注很相近,但是它们没有数字标签或以 #开始.
reST 支持替换 “substitutions” (ref
有一小段文本或标记被关联到 |name|.
定义与尾注一样需有明确的标记块,如下:
.. |name| replace:: replacement *text*
或者:
.. |caution| image:: warning.png :alt: Warning!
详情查看reST reference for substitutions
如果想在所有文档中使用这些替换, 需把它们放在 rst_prolog
或一个单独文件里, 然后在使用它们的文档文件里包含这个文件,包含指令
:rstinclude .
(请给出包含文件的扩展名,已区别于其他的源文件,避免Sphinx将其作为独立的文档文件.)
Sphinx 定义了一些默认的替换, 请查看 default-substitutions.
有明确标记块但又不是有效的结构标记的标记 (像上面的尾注)都被视为评论(ref
.. 这是一个评论.
可以通过缩进产生多行评论:
.. 这整个缩进块都是 一个评论. 仍是一个评论.
在reST使用Unicode字符可以容易的包含特殊字符如破折号,版权标志. Sphinx默认源文件使用UTF-8 编码; 你可以通过 source_encoding 的配置值改变编码.
具体使用中可能会遇到一些问题:
the
reference
.[^1]: 当默认主域里包含指令 :rstclass , 这个指令将被隐藏 因此, Sphinx使用:rstrst-class.