reStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to provide authors with enough information to author documents productively.

2020年5月6日 · Use RstCloth to create RST-files via an easy Python API. from rstcloth import RstCloth d = RstCloth() d.title('Example Use') d.newline() d.h2('Contents') d.directive(name="contents", fields=[('local', ''), ('backlinks', 'None')]) d.newline() d.h2('Code -- shebang') d.codeblock('#!/usr/bin/env') d.print_content()

这本书专注于 ReStructuredText 格式的最常用用法，以便读者能以最快时间掌握。 全书分为三个部分： 第三部分是Sphinx标记结构篇，主要介绍 rst 文本的标记结构如何使用。 同时，这个教程也可当作 rst 文本的语法手册查询，使用左边栏的目录和搜索栏可以很方便的查阅。 本书使用的reStructuredText标记语言，相对Markdown来说，在写书方面更有优势: 本书为开源图书，版权归作者所有；欢迎下载及编辑 (个人用途)，但未经作者同意必须保留此段声明，且不可用于商业 …

reStructuredText（可简写为RST、ReST或reST）是一种用于文本数据的文件格式，主要用于 Python 编程语言社区的技术文档。 它是Python Doc-SIG（Documentation Special Interest Group）的 Docutils 项目的一部分，旨在为 Python 创建一组类似于 Java 的 Javadoc 或 Perl 的 Plain Old Documentation（pod）的工具。 Docutils 可以从 Python 程序中提取注释和信息，并将它们格式化为各种形式的程序文档。

号表示对信号电平取反），也就是if(!rst_n)，表示如果！ rst_n为逻辑1（即如果rst_n为低电平），则进行复位。 这段程序的意义是rst_n为低电平时进行异步复位。

All reST files use an indentation of 3 spaces; no tabs are allowed. The maximum line length is 80 characters for normal text, but tables, deeply indented code samples and long links may extend beyond that. Code example bodies should use normal Python 4-space indentation.

The reStructuredText (RST) syntax provides an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. However, you need to be very precise and stick to some strict rules: like Python, RST syntax is sensitive to indentation ! This entire document is written with the RST syntax.

To show example code, use the reStructured Text code-block directive: code. By specifying the language, you enable pygments, which show syntax color coding for that code sample. (Ensure that your project conf.py file contains pygments_style = 'sphinx').

2018年6月5日 · 这种文档的组织方式核心是使用了 reStructuredText 标记语言编写文档。 markdown 同样也是在程序员圈子里比较受欢迎的标记语言，大大减轻了编写文档的难度，reStructuredText 也是一直标记语言，两者存在共性也存在差异性。 sphinx 是一个基于python的文档生成工具，许多 python 项目都用使用这个工具自动生成文档。 学习语法之前先思考个问题：一篇文档的构成要素有哪些？ 经过这样的思考便于朝着目标学习核心的语法点。 上述6个部 …

reStructuredText is a lightweight markup language that is used in static site generators like Sphinx. It contains robust tools for semantic markup, reusing content, and content filters for different kinds of outputs.