[英]Force Sphinx to interpret Markdown in Python docstrings instead of reStructuredText
我正在使用 Sphinx 来记录一个 python 项目。 我想在我的文档字符串中使用 Markdown 来格式化它们。 即使我使用recommonmark
扩展名,它也只涵盖手动编写的.md
文件,而不是文档字符串。
我在我的扩展中使用autodoc
、 napoleon
和recommonmark
。
如何在我的文档字符串中进行 sphinx 解析降价?
每次处理文档字符串时,Sphinx的autodoc
扩展都会发出一个名为autodoc-process-docstring
的事件。 您可以挂钩该机制将语法从Markdown转换为reStructuredText。
我不知道为什么recommonmark
不能提供开箱即用的功能。 这应该是一个简单的功能添加。 就个人而言,我在我的项目中使用m2r
进行转换。 因为它很快 - pandoc
如pandoc
快得多。 速度很重要,因为转换会动态发生并单独处理每个文档字符串。 除此之外,任何Markdown-to-reST转换器都可以。
安装m2r
并将以下内容添加到Sphinx的配置文件conf.py
:
import m2r
def docstring(app, what, name, obj, options, lines):
md = '\n'.join(lines)
rst = m2r.convert(md)
lines.clear()
for line in rst.splitlines():
lines.append(line)
def setup(app):
app.connect('autodoc-process-docstring', docstring)
[已编辑添加... ]
就像上面一样,但有commonmark
:
import commonmark
def docstring(app, what, name, obj, options, lines):
md = '\n'.join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
for line in rst.splitlines():
lines.append(line)
def setup(app):
app.connect('autodoc-process-docstring', docstring)
这使用与Sphinx扩展recommonmark
相同的Markdown解析器,并且与m2r
一样快,这意味着与本机reStructuredText相比,接下来对构建时间没有影响。
基于@john-hennig 的回答,以下内容将保留重组后的文本字段,例如: :py:attr:
、 :py:class:
等。 这允许您引用其他类等。
import re
import commonmark
py_attr_re = re.compile(r"\:py\:\w+\:(``[^:`]+``)")
def docstring(app, what, name, obj, options, lines):
md = '\n'.join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
lines += rst.splitlines()
for i, line in enumerate(lines):
while True:
match = py_attr_re.search(line)
if match is None:
break
start, end = match.span(1)
line_start = line[:start]
line_end = line[end:]
line_modify = line[start:end]
line = line_start + line_modify[1:-1] + line_end
lines[i] = line
def setup(app):
app.connect('autodoc-process-docstring', docstring)
我不得不扩展 john-hen 接受的答案,以允许Args:
条目的多行描述被视为单个参数:
def docstring(app, what, name, obj, options, lines):
wrapped = []
literal = False
for line in lines:
if line.strip().startswith(r'```'):
literal = not literal
if not literal:
line = ' '.join(x.rstrip() for x in line.split('\n'))
indent = len(line) - len(line.lstrip())
if indent and not literal:
wrapped.append(' ' + line.lstrip())
else:
wrapped.append('\n' + line.strip())
ast = commonmark.Parser().parse(''.join(wrapped))
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
lines += rst.splitlines()
def setup(app):
app.connect('autodoc-process-docstring', docstring)
当前的@john-hennig 很棒,但似乎在多行Args:
失败了Args:
python 风格。 这是我的修复:
def docstring(app, what, name, obj, options, lines):
md = "\n".join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
lines += _normalize_docstring_lines(rst.splitlines())
def _normalize_docstring_lines(lines: list[str]) -> list[str]:
"""Fix an issue with multi-line args which are incorrectly parsed.
```
Args:
x: My multi-line description which fit on multiple lines
and continue in this line.
```
Is parsed as (missing indentation):
```
:param x: My multi-line description which fit on multiple lines
and continue in this line.
```
Instead of:
```
:param x: My multi-line description which fit on multiple lines
and continue in this line.
```
"""
is_param_field = False
new_lines = []
for l in lines:
if l.lstrip().startswith(":param"):
is_param_field = True
elif is_param_field:
if not l.strip(): # Blank line reset param
is_param_field = False
else: # Restore indentation
l = " " + l.lstrip()
new_lines.append(l)
return new_lines
def setup(app):
app.connect("autodoc-process-docstring", docstring)
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.