如何使用README.md文件作为shpinx readthedocs的主页

Question

我有一个

README.md

文件，其中包含软件包的一般概述，并且想使用 spinx 将该文件作为主主页添加到我的文档中，您能告诉我如何将其添加到我的

index.rst

中吗？预先感谢

索引.rst

my_apckage
==========

.. toctree::
   :maxdepth: 4

   my_package.main_page

PS：由于我是Sphinx的初学者，所以我采用了示例作为

conf.py

Answer 1

您可以为此使用 include 指令 喜欢：

my_apckage
==========

.. toctree::
   :maxdepth: 4

   my_package.main_page

.. include:: ../README.rst

如果您有 Markdown 格式的自述文件（我相信是这样），您可以执行以下操作。 此外，您还需要一个用于解析 Markdown 的扩展。 （我用过MyST）

.. include:: ../README.md
   :parser: myst_parser.sphinx_
   :start-after: <!-- index.rst content start -->

您还可以配置包含文件的数量 例如，您可以查看我的 this 项目的 index.rst 文件。 index.html 是 99% README.md