如何在 readthedocs 中使用 myst_parser 和 sphynx？

Question

我可以在我的计算机上完全构建文档并打开 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 使用它？ 再次

我的 GitHub 存储库，我的 readthedocs 页面

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

Answer 1

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

source_suffix = [
    ".md",
]

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