微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

如何解决强制 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 举报,一经查实,本站将立刻删除。