强制 Sphinx 在 Python 文档字符串中用 MyST 解释 Markdown 而不是 reStructuredText

问题描述

我是 Sphinx 的新手,我试图弄清楚如何将 MyST 解析器用于 sphinx 以使其与 .autodoc 扩展名一起使用。

我找到了 this 线程。我一直在尝试将此代码转换为与 MyST 一起使用,但失败了。

我一直在尝试做这样的事情:

import myst_parser

def docstring(app,what,name,obj,options,lines):
    md  = '\n'.join(lines)
    ast = myst_parser.sphinx_parser.MystParser().parse(md)
    rst = myst_parser.ReStructuredTextRenderer().render(ast)
    lines.clear()
    lines += rst.splitlines()

def setup(app):
    app.connect('autodoc-process-docstring',docstring)

我不知道我还应该向 parse 方法传递什么。以及之后做什么(从我看到的 myst_parser 没有 ReStructuredTextRenderer)。

有人可以帮我吗? 谢谢

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)