我正在使用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中一样,缩进在reST中很重要,因此同一段落中的所有行必须左对齐到相同的缩进级别.
我开始认为Python开发人员的指南可能是异常,而不是其他所有内容,特别是因为在我所有的搜索中,我在使用Sphinx时基本上没有讨论过"3-or-4空间问题".蟒蛇.