使Sphinx格式化Python文档字符串中的Markdown代码示例

时间:2018-04-16 18:47:46

标签: python-sphinx

我正在尝试使用Sphinx自动生成Python库的API文档,我无法正确格式化文档字符串中的示例代码片段 - 它们确实缩进但是相同缩进的行会被连接起来(https://weka-io.github.io/easypy

我理解问题是我用来标记代码块的格式是Markdown(将它们缩进4个空格)但是Sphinx期望reStructuredText(code-block::

我尝试使用Google搜索解决方案并建议使用recommonmark - 但似乎是使用.md文件作为源。我正在使用sphinx-apidoc从Python代码生成“源”.rst文件 - 所以它不起作用(除非有办法让sphinx-apidoc生成{{1}而不是文件)

那么 - 我如何让Sphinx将Python文档字符串视为Markdown,将精心设计的reStructuredText框架保留为其他所有内容?

0 个答案:

没有答案