Python sphinx 使Sphinx格式化Python DocString中的标记代码示例

我试图使用Sphinx为Python库自动生成API文档，但我无法使其正确格式化docstrings中的示例代码段-它们确实缩进，但相同缩进的行被连接起来（）

我知道问题在于，我用来标记代码块的格式是Markdown（将它们缩进4个空格），但Sphinx需要重新构造文本（

代码块：：

）

我试过用谷歌搜索一个解决方案，它建议使用-但似乎是使用

.md

文件作为源代码。我正在使用

sphinx-apidoc

从Python代码生成“source”

.rst

文件，因此它不会工作（除非有办法让

sphinx-apidoc

生成

.md

文件）

---

那么-如何让Sphinx仅将Python文档字符串作为标记，而将精心构建的StructuredText框架与其他框架保持一致？

看起来您只需要添加一个冒号来引入文本块（

示例：

而不是

示例：

）。请参阅（我不明白标记与此有什么关系）。@mzjn添加额外的冒号是代码块的reStructuredText语法，仅按四列缩进就是标记语法。在我添加文档生成之前，这个项目已经存在了几年，如果可能的话，我更喜欢更改一些Sphinkx配置，使其接受降价，而不是将项目中的所有docstring修改为StructuredText。好的。。。我将重构所有内容以使用StructuredText…的可能副本