其一般保存的文件以.rst为后缀。在必要的时候,.rst文件可以被转化成PDF或者HTML格式,也可以有Sphinx转化为LaTex,man等格式,现在被广泛的用于程序的文档撰写。...*鸭*
鸡的崇拜者
嵌入程序代码
如果需要嵌入大段的程序代码(SQL, 业务逻辑设置, 配置文件等), 在段落末尾添加两个’:’, 并且代码块需要与周围文本以空行分隔,代码的左侧必须缩进, 代码引用到没有缩进的行为止...及上划线表示部分
* 及上划线表示章节
=, 小章节
-, 子章节
^, 子章节的子章节
", 段落
显示标记
显式标用在那些需做特殊处理的reST结构中, 如尾注,突出段落,评论,通用指令....开始,后跟空白符,与下面段落的缩进一样. (在显示标记与正常的段落间需有空行,这听起来有些复杂,但是写起来会非常直观.)
指令
指令是显式标记最常用的模块。...Sphinx 会自动将图像文件拷贝到输出目录的子目录里,( 输出HTML时目录为 _static )
注释
有明确标记块但又不是有效的结构标记的标记 (像上面的尾注)都被视为注释,例如:
..