重构文本

RestructuredText的工作原理有很多指南,但这并不能代替它们。它只是一个常见格式选项的简短示例,可用于快速阅读文档。

重构文本约定

下面是一些关于如何在RestructedText中创建文档页面的基本指针。

线条长度

RestructuredText中的行长度不应超过79个字符

标题

标题为:

H1

文本行上方和下方的一行。文档中应该只有一个h1。例子:

###############
Heading Level 1
###############

氢气

一排 * 在文本行的上方和下方。例子:

***************
Heading Level 2
***************

H3

文本行下的一行='s。例子:

Heading Level 3
===============

H4

在文本行的下面有一行-。例子:

Heading Level 4
---------------

H5

文本行下方的一行^。例子:

Heading Level 5
^^^^^^^^^^^^^^^

H6

文本行下方的一行“”。例子:

Heading Level 6
"""""""""""""""

文本格式

斜体字

单个环绕词 星号

*italics*

大胆的

带双引号的环绕词 星号

**bold**

字面意义的

带双反勾号的替代词:

``double back-quotes``

列表

列表前面必须始终有空行。

编号列表

编号列表是数字或字母,后跟“.”,右括号”)或由括号“()”包围。

This is a numbered list:

1) Item 1
2) Item 2

显示为:

这是一个编号列表:

  1. 项目1

  2. 项目2

项目符号

项目符号点行以“-”、“+”或“*”开头

This is a bullet point list:

* Item 1
* Item 2

显示为:

这是一个要点列表:

  • 项目1

  • 项目2

代码块

使用code block指令显示代码,包括根据需要突出显示的语法。

命令行

将此指令用于文本,如命令行输入和输出(注意代码的空格缩进量为2):

.. code-block:: text

  code here...

Python

对python使用此指令(注意代码的空格缩进量为2):

.. code-block:: python

  code here...

图像

.. image:: images/build1.png