3.reStructuredText 语法指南¶

3.reStructuredText 语法指南¶

3.1.1. 理解 RST¶

reStructuredText(可简写为RST、ReST或reST)是一种用于文本数据的文件格式,主要用于 Python 编程语言社区的技术文档。

它是Python Doc-SIG(Documentation Special Interest Group)的 Docutils 项目的一部分,旨在为 Python 创建一组类似于 Java 的 Javadoc 或 Perl 的 Plain Old Documentation(pod)的工具。Docutils 可以从 Python 程序中提取注释和信息,并将它们格式化为各种形式的程序文档。

reStructuredText 是一种轻量级标记语言,其设计目的是(a)文档处理软件(如Docutils)可以处理它,(b)读和写 Python 源代码的程序员很容易读它。而本教程介绍的 Sphinx,则是从 reStructuredText 文档生成 HTML/PDF 的工具。

学习本章 reStructuredText 语法,首先要理解两种标记元素:指令(Directives)和角色(Role)。区别在于指令是块级元素,像段落一样使用。角色是行内元素,可以写在普通文本之中。

相关新闻

金蝶OA系统怎么样?
office365怎么登陆

金蝶OA系统怎么样?

🕒 07-28 👽 2702
如何在微信中轻松设置指纹支付功能?详细步骤与常见问题解答
坦克世界t110e5配件怎么选(T110E5重坦改装建议)
365黑道老大免费观看第一季在线

坦克世界t110e5配件怎么选(T110E5重坦改装建议)

🕒 07-29 👽 674
创意无界!如何以“文创+”推动“文化出海”?
office365怎么登陆

创意无界!如何以“文创+”推动“文化出海”?

🕒 09-14 👽 5324
apec成员国有哪些国家(apec成员国分布图)
office365怎么登陆

apec成员国有哪些国家(apec成员国分布图)

🕒 09-17 👽 915
7笔画、笔顺字
bet3365官网

7笔画、笔顺字

🕒 07-07 👽 6848