重構文本?

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