我如何在 readthedocs 中将 myst_parser 与 sphynx 一起使用?

How can i use myst_parser with sphynx in readthedocs?

我可以在我的电脑上完全正常地构建文档并打开 HTML 结果,它看起来很棒,但是当我推送到 GitHub 并阅读文档试图构建它时 -我收到以下错误:

root file /home/docs/checkouts/readthedocs.org/user_builds/cry-vs-py/checkouts/latest/docs/index.rst not found

我的索引文件有 .md 扩展名而不是 .rst。我怎样才能告诉 read-the-docs 使用它?再次

我的my GitHub repo, my readthedocs page

我需要能够使用 .md 而不是 .rst,因为我真的不理解重组文本。谢谢。

conf.py 中设置 source_suffix 的值以包含 Markdown 文件。

source_suffix = [
    ".md",
]

然后安装源解析器扩展,例如MyST。有关安装和配置详细信息,请参阅解析器的文档。