如何将README.md作为Sphinx文档主页并添加至index.rst？

步骤1：安装Markdown解析扩展 #

Sphinx默认仅支持reStructuredText格式，要解析Markdown文件需安装m2r2工具：

pip install m2r2

步骤2：配置conf.py启用扩展 #

打开你的conf.py配置文件，在extensions列表中添加'm2r2'：

extensions = [
    # 保留你已有的其他扩展，比如'sphinx.ext.autodoc'、'sphinx_rtd_theme'等
    'm2r2'
]

步骤3：修改index.rst引入README.md #

调整你的index.rst内容，通过include指令将README.md的内容嵌入主页面，示例如下：

my_package
==========

.. include:: ../README.md

.. toctree::
   :maxdepth: 4
   :caption: 文档目录

   my_package.main_page

注意：../README.md是相对路径，需根据你的项目结构调整。若README.md与index.rst在同一目录，直接写README.md即可。

如果README.md中包含相对路径的图片或链接，需要调整为适配Sphinx构建环境的路径，避免构建后无法访问。

内容的提问来源于stack exchange，提问作者bhomaidan90