reST需要3空格缩进吗?

Tim*_*Tim 7 python documentation restructuredtext python-sphinx

我正在使用Sphinx记录我的Python代码,并阅读Python开发人员指南(我想其他地方),reST文件使用3个空格的缩进:

所有reST文件都使用3个空格的缩进; 没有标签是允许的.

这是我为我的索引文件复制的示例的情况,以及我的IDE选择3空间缩进并将其用于整个页面的一些其他文件.该sphinx-apidoc扩展还modules.rst为其构建的文件使用3个空格.

另一方面,因为Python使用4空格缩进,所以我的所有文档字符串都缩进了4个空格.此外,.. automodule::生成的指令sphinx-apidox用4个空格缩进.

关键是,它仍然有效!所以我想知道3空间缩进是否是一个要求,或者它是否是一个好习惯,但仅限于风格?(如果是这样,为什么,当所有Python都是4空间缩进的时候?)

或者有没有3空间缩进会破坏我的构建的情况?

我看过的其他地方


我开始认为Python开发人员的指南可能是异常,而不是其他所有内容,特别是因为在我所有的搜索中,我在使用Sphinx时基本上没有讨论过"3-or-4空间问题".蟒蛇.

Ste*_*rcy 9

正如您通过对权威来源和其他地方的研究所发现的那样,没有明确的缩进规范,除了选项列表至少有2个空格,脚注至少有3个空格.请参阅reStructuredText的缩进规范.

也就是说,有一些建议.

  1. 选择一种样式并使其与文档保持一致.
  2. IDE经常抱怨缩进不正确,比如Python中的文档字符串,因此使用4个空格可以避免这些警告.
  3. 可以将IDE设置为缩进到4个代码空间,那么为什么不保持文档相同呢?
  4. 有关编号列表的缩进,请参阅我的奖金提示.