reST 中是否需要 3 個空格的縮進？

Question

我正在使用 Sphinx 記錄我的 Python 代碼，並在 Python 開發人員指南（我認為在其他地方也是如此）中閱讀了 reST 文件使用 3 個空格的縮進：

所有 reST 文件都使用 3 個空格的縮進； 不允許使用標簽。

這是我為索引文件復制的示例的情況，以及我的 IDE 選擇 3 空格縮進並將其用於整個頁面的其他一些文件。 sphinx-apidoc擴展還為它構建的modules.rst文件使用了 3 個空格。

另一方面，因為 Python 使用 4 個空格縮進，所以我所有的文檔字符串都縮進了 4 個空格。 此外，由sphinx-apidox生成的.. automodule::指令縮進 4 個空格。

關鍵是，這一切仍然有效！ 所以我想知道 3 空格縮進是否是必需的，或者它是否是一種很好的做法，但僅限於樣式？ （如果是這樣，為什么 Python 的所有內容都是 4 個空格縮進的？）

或者是否有沒有 3 空格縮進會破壞我的構建的情況？

我看過的其他地方

• Sphinx reStructuredText Primer沒有提到特定數量的空格，只是：

  與 Python 一樣，reST 中的縮進很重要，因此同一段落的所有行都必須左對齊到相同的縮進級別。

• 這個（未回答的）SO question ，它是關於列表的，而不是一般的間距
• reStructuredText 標記規范在腳注中只提到了 3 個空格。
• GitHub 上的這個問題，盡管我認為這里的這個問題是不同元素的縮進級別的混合。

---

我開始認為 Python 開發人員指南可能是異常，而不是其他一切，特別是因為在我所有的搜索中，我在使用 Sphinx 時基本上沒有遇到“3 或 4 空間問題”的討論，並且蟒蛇。

Answer 1

正如您通過對權威來源和其他地方的研究發現的那樣，除了選項列表至少 2 個空格和腳注至少 3 個空格外，沒有明確的縮進規范。 請參閱有關reStructuredText 縮進的規范。

也就是說，有一些建議。

1. 選擇一種樣式並使其與您的文檔保持一致。
2. IDE 經常抱怨不正確的縮進，例如 Python 中的文檔字符串，因此使用 4 個空格可以避免這些警告。
3. IDE 可以設置為代碼縮進 4 個空格，那么為什么不將其保留為文檔相同呢？
4. 請參閱我關於縮進編號列表的額外提示。