• 文件 >
  • 3. 段落級別標記
快捷方式

3. 段落級別標記

3.1. 行內標記

段落包含文字,並可能包含行內標記:強調強強調行內 字面量、獨立超連結 (https://python.club.tw)、外部超連結 (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 標籤不應超出 行高,以免 干擾 鄰近行的文字。

鍵繫結指示讀者需要按下鍵盤或滑鼠上的按鈕,例如 MMBShift-MMB。另一種指示使用者操作的有用標記是使用 選單選擇,這可用於在軟體中顯示短選單和長選單。例如,此處可見 選單選擇,它太長而無法容納在一行中。 我的 ‣ 軟體 ‣ 某個選單 ‣ 某個子選單 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 小姐的理論。括號,小姐,括號。這個理論如下,現在開始。所有雷龍一端細,中間非常非常粗,然後在另一端又變細。這就是我的理論,它是我的,屬於我,我擁有它,它就是這個東西。

—Anne 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.8.0.dev0+3b30409.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. 帶行號的強調行

1def some_function():
2    interesting = False
3    print 'This line is highlighted.'
4    print 'This one is not...'
5    print '...but this one is.'

3.6. 引用

3.6.1. 腳註

1(1,2)

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

這是腳註的第二段。

2(1,2)

腳註可以手動編號 (如 1) 或使用以“#”為字首的標籤自動編號。此腳註帶有標籤,因此可以從多個地方引用,既可以作為腳註引用 (2),也可以作為超連結引用 (label)。

3

此腳註僅使用“#”標籤進行自動匿名編號。

*

腳註也可以使用符號,透過“*”標籤指定。這是對下一個腳註的引用:

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

4

這是一個未引用的腳註,引用了一個不存在的腳註:[5]_

3.6.2. 引文

11

這是我引用的文獻,我們把它弄得非常長,以便可以看出它不遵循正常的響應式表格規則。

12(1,2)

這個引文包含一些 程式碼塊,可能還有一些 粗體斜體。哎呀,我們甚至放一個指向元引文 13 的連結。

13

此引文將有兩個反向連結。

這是對上面引文的引用,12,以及一個 [nonexistent] 引文。

這是另一種引文型別:引文

3.6.3. 術語表

這是一個包含定義術語的術語表,例如 寫作

文件

為使用者提供使用某物所需的知識。

閱讀

透過使用眼睛將資訊攝入腦中的過程。

寫作

將思想放入介質中供他人閱讀的過程。

3.6.4. 目標

此段落由顯式“示例”目標指向。可以在上方的行內標記下找到參考。還可能存在行內超連結目標

節標題是隱式目標,按名稱引用。參見目標,它是`正文元素`_的子節。

顯式外部目標被插入到引用中,例如“Python 5”。

目標可以是間接和匿名的。因此,這個短語也可以指向目標節。

這是一個`沒有目標的超連結引用`_,它會生成一個錯誤。

3.7. 指令

3.7.1. 目錄

這些只是眾多 reStructuredText 指令中的一部分示例。對於其他指令,請參見:http://docutils.sourceforge.net/docs/ref/rst/directives.html

3.7.2. 居中文字

你可以使用 .. centered:: 建立一個包含居中文字的語句

這是居中文字!

3.7.3. 影像與圖

3.7.3.1. 影像

一個影像指令 (也可點選 – 一個超連結引用)

../../../../_images/yi_jing_01_chien.jpg

3.7.3.2.

reStructuredText, the markup syntax

圖是帶有標題和/或圖例的影像:

re

修訂,重訪,基於 're' 模組。

Structured

結構增強文字,structuredtext。

Text

嗯,確實是,不是嗎?

此段落也是圖例的一部分。

一個帶居中對齊的圖指令

../../../../_images/yi_jing_01_chien.jpg

此標題應該居中。

3.7.4. 提示框

注意

通用指令。

小心

別被騙了。

危險

瘋狂科學家工作中!

錯誤

無法計算。

提示

它比麵包盒大。

重要

  • 洗你的耳朵後面。

  • 收拾你的房間。

    • 包括衣櫃。

    • 浴室也是。

      • 把浴室裡的垃圾拿出去。

      • 清理洗手池。

  • 給你媽媽打電話。

  • 備份你的資料。

注意

這是一個注意。注意內的方程:\(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)

https://python.club.tw/

3.7.7. 替換文字

我建議你嘗試Python,最好的語言 5

3.7.8. 複合段落

此段落包含一個字面塊

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

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

這種結構稱為複合段落,可以使用“compound”指令生成。

文件

訪問 PyTorch 的全面開發者文件

檢視文件

教程

獲取針對初學者和高階開發者的深度教程

檢視教程

資源

查詢開發資源並獲得解答

檢視資源