如何在 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 。 有關安裝和配置的詳細信息，請參閱解析器的文檔。