3. 段落層級標記 ¶

3.1. 行內標記 ¶

段落包含文字，並且可能包含行內標記：強調、強烈強調、行內文字、獨立超連結 (http://www.python.org)、外部超連結 (Python 5)、內部交叉參考 (範例)、帶有內嵌 URI 的外部超連結 (Python 網站)、腳註參考 (手動編號 1、匿名自動編號 3、標記自動編號 2 或符號 *)、引文參考 (12)、取代參考 () 和行內超連結目標 (請參閱下方的目標以取得此處的回溯參考)。字元層級的行內標記也是可能的 (雖然非常難看！) 在 reStructuredText 中。問題以 |problematic| 文字表示 (由處理錯誤產生；這是一個故意的錯誤)。

另外，透過 sphinx.ext.autodoc，我在示範中使用它，我可以連結到 test_py_module.test.Foo。它會將您連結到我的程式碼文件。

已解譯文字的預設角色是標題參考。以下是一些明確的已解譯文字角色：PEP 參考 (PEP 287)；RFC 參考 (RFC 2822)；_下標；^上標；以及用於標準行內 標記 的明確角色。

GUI 標籤是一種指示使用者要採取某些動作的實用方式。GUI 標籤不應超過 行高，以免干擾相鄰行的文字。

按鍵綁定指示讀取器要按下鍵盤或滑鼠上的按鈕，例如 MMB 和 Shift-MMB。另一個指示使用者動作的實用標記是使用 menuselection，這可用於顯示軟體中的簡短和長選單。例如，menuselection 在此處可以看到，換行符號太長而無法容納在此行中。我的 ‣ 軟體 ‣ 某些選單 ‣ 某些子選單 1 ‣ 子選單 2。

讓我們測試行內文字中的換行和空白字元重要性：This is an example of --inline-literal --text, --including some-- strangely--hyphenated-words. Adjust-the-width-of-your-browser-window to see how the text is wrapped. -- ---- -------- Now note the spacing between the words of this sentence (words should be grouped in pairs).

如果提供了 --pep-references 選項，則此處應該有一個指向 PEP 258 的即時連結。

3.2. 數學 ¶

這是一個測試。這是一個方程式：\(X_{0:5} = (X_0, X_1, X_2, X_3, X_4)\)。這是另一個

(1)¶\[\nabla^2 f = \frac{1}{r^2} \frac{\partial}{\partial r} \left( r^2 \frac{\partial f}{\partial r} \right) + \frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta} \left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) + \frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}\]

您可以透過使用 :eq: 來新增連結到方程式，例如上面的方程式 (1)。

3.3. 中繼資料 ¶

3.4. 區塊 ¶

3.4.1. 文字區塊 ¶

文字區塊以先行段落結尾的雙冒號 (「::」) 表示 (就在那邊 -->)。它們可以是縮排的

if literal_block:
    text = 'is left as-is'
    spaces_and_linebreaks = 'are preserved'
    markup_processing = None

或者它們可以在沒有縮排的情況下引用

>> Great idea!
>
> Why didn't I think of that?

3.4.2. 行區塊 ¶

這是一個行區塊。它以空白行結尾。

每個新行都以垂直線 (「|」) 開頭。

保留換行符號和初始縮排。

接續行是長行的換行部分；它們以空格代替垂直線開頭。

接續行的左邊緣不需要與上方文字的左邊緣對齊。

這是第二個行區塊。

內部允許空白行，但它們必須以「|」開頭。

開始吧，樂隊指揮艾瑞克！

一、二，一二三四

半隻蜜蜂，從哲學上來說，

必須，事實上，一半不是。

但是半隻蜜蜂必須是，

相對於 它的實體。你明白嗎？

但是可以說蜜蜂是

或不是一隻完整的蜜蜂，

當半隻蜜蜂不是蜜蜂時，

由於一些古老的傷害？

唱歌…

3.4.3. 區塊引文 ¶

區塊引文由縮排的本文元素組成

A. Elk 的理論。括號小姐，括號。這個理論如下，現在開始。所有的雷龍一端都很細，中間部分非常粗，然後遠端又變細。這就是我的理論，它是我的，屬於我，我擁有它，以及它是什麼。

—安妮·艾克 (小姐)

3.4.4. Doctest 區塊 ¶

>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)

3.4.5. 程式碼區塊 ¶

# parsed-literal test
curl -O http://someurl/release-v2.7.0.dev0+426562f.tar-gz

程式碼區塊可以有標題。¶

{
"windows": [
    {
    "panes": [
        {
        "shell_command": [
            "echo 'did you know'",
            "echo 'you can inline'"
        ]
        },
        {
        "shell_command": "echo 'single commands'"
        },
        "echo 'for panes'"
    ],
    "window_name": "long form"
    }
],
"session_name": "shorthands"
}

3.4.5.1. 帶行號的強調行 ¶

def some_function():
    interesting = False
    print 'This line is highlighted.'
    print 'This one is not...'
    print '...but this one is.'

3.5. 側邊欄 ¶

第一個六十四卦由六條不斷的線組成。這些不斷的線代表原始力量，它是光明的、活躍的、強大的和精神的。六十四卦在性格上始終強大，並且由於它沒有弱點，因此它的本質是力量或能量。它的形象是天空。它的能量被認為不受空間中任何固定條件的限制，因此被認為是運動。時間被視為這種運動的基礎。因此，六十四卦也包括時間的力量和持續時間的力量，即持續性。

六十四卦所代表的力量應從雙重意義上來解釋，即它對宇宙的作用以及它對人類世界的作用。關於宇宙，六十四卦表達了神靈的強大創造力。關於人類世界，它表示聖人或聖賢、統治者或人類領袖的創造力，他們透過自己的力量喚醒和發展他們更高的本性。

3.5.1. 帶側邊欄的程式碼 ¶

文字包含也可以有標題。¶

# -*- coding: utf-8 -*-
"""Test Module for sphinx_rtd_theme."""


class Foo:

    """Docstring for class Foo.

    This text tests for the formatting of docstrings generated from output
    ``sphinx.ext.autodoc``. Which contain reST, but sphinx nests it in the
    ``<dl>``, and ``<dt>`` tags. Also, ``<tt>`` is used for class, method names
    and etc, but those will *always* have the ``.descname`` or
    ``.descclassname`` class.

    Normal ``<tt>`` (like the <tt> I just wrote here) needs to be shown with
    the same style as anything else with ````this type of markup````.

    It's common for programmers to give a code example inside of their
    docstring::

        from test_py_module import Foo

        myclass = Foo()
        myclass.dothismethod('with this argument')
        myclass.flush()

        print(myclass)


    Here is a link to :py:meth:`capitalize`.
    Here is a link to :py:meth:`__init__`.

    """

    #: Doc comment for class attribute Foo.bar.
    #: It can have multiple lines.
    bar = 1

    flox = 1.5   #: Doc comment for Foo.flox. One line only.

3.6. 參考文獻 ¶

3.6.1. 腳註 ¶

1(1,2)

腳註包含本文元素，始終縮排至少 3 個空格。

這是腳註的第二段。

2(1,2)

腳註可以編號，手動編號 (如 1) 或使用「#」開頭的標籤自動編號。此腳註有一個標籤，因此可以從多個位置引用它，既可以作為腳註參考 (2) 又可以作為超連結參考 (標籤)。

3

此腳註使用僅「#」的標籤自動匿名編號。

*

腳註也可以使用符號，使用「*」標籤指定。這是對下一個腳註的參考：†。

†

此腳註顯示序列中的下一個符號。

4

這是一個未參考的腳註，參考了一個不存在的腳註：[5]_。

3.6.2. 引文 ¶

11: 這是我做的引文，讓我們把它弄得非常長，以便我們可以判斷它不遵循正常的響應式表格內容。
12(1,2): 此引文中有一些 程式碼區塊，可能還有一些粗體和斜體。見鬼了，讓我們也連結到元引文 13。
13: 此引文將有兩個反向連結。

這是對上述內容的參考，12，以及 [不存在的] 引文。

這是另一種引文類型：引文

3.6.3. 詞彙表 ¶

這是一個詞彙表，其中包含諸如寫作之類的術語定義

文件¶: 為使用者提供使用某物所需的知識。
閱讀¶: 透過使用眼睛將資訊輸入頭腦的過程。
寫作¶: 將想法放入媒介供其他人閱讀的過程。

3.6.4. 目標 ¶

本段由明確的「範例」目標指向。參考可以在上面的行內標記下找到。行內超連結目標也是可能的。

章節標題是隱含目標，由名稱引用。請參閱目標，它是 `本文元素`_ 的子章節。

明確的外部目標會插入到諸如「Python 5」之類的參考中。

目標可能是間接的和匿名的。因此，此短語也可能指目標章節。

這是一個 `沒有目標的超連結參考`_，它會產生錯誤。

警告

不要拿任何木製鎳幣。

危險

瘋狂科學家在工作！

錯誤

無法計算。

提示

它比麵包盒還大。

重要

洗耳朵後面。
整理你的房間。
- 包括衣櫥。
- 浴室也是。
  - 把浴室的垃圾拿出去。
  - 清潔水槽。
打電話給你媽媽。
備份您的資料。

注意

這是一個注意事項。注意事項中的方程式：\(G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})\)。

提示

如果服務良好，則為 15%。

範例
事物 1
事物 2
事物 3

警告

強烈的散文可能會引起極端的腦力勞動。強烈建議讀者自行斟酌。

而且，順便說一句…

您也可以編造自己的警示。

3.7.5. 主題、側邊欄和標題 ¶

主題標題

這是一個主題。

這是一個標題

3.7.6. 目標腳註 ¶

5(1,2,3): http://www.python.org/

3.7.7. 取代文字 ¶

我建議您試試 Python，最好的 語言 5。

3.7.8. 複合段落 ¶

此段落包含文字區塊

Connecting... OK
Transmitting data... OK
Disconnecting... OK

因此由一個簡單的段落、一個文字區塊和另一個簡單的段落組成。儘管如此，它在語義上是一個段落。

此構造稱為複合段落，可以使用「compound」指示詞產生。

3.8. 下載連結 ¶

This long long long long long long long long long long long long long long long download link should be blue, normal weight text with a leading icon, and should wrap white-spaces