关于ReadTheDocs部署及Sphinx结合Markdown使用的技术咨询

关于GitHub+ReadTheDocs的本地工具依赖 #

• 没错，不需要本地安装任何软件，直接在GitHub网页端创建、编辑文档文件，提交后ReadTheDocs会自动同步并完成文档构建和展示。
• 本地安装Python、Sphinx这类工具，仅用于在本地预览文档的排版效果，属于可选操作，不是必须流程。

让ReadTheDocs自动安装myst_parser扩展 #

要实现用Markdown编写Sphinx文档且无需本地安装依赖，只需两步：

1. 在项目根目录创建requirements.txt文件，写入内容：

myst_parser

ReadTheDocs在构建文档时，会自动读取这个文件并安装指定的依赖包。
2. 修改Sphinx的配置文件conf.py，将myst_parser加入扩展列表：

extensions = [
    # 保留你原本已有的其他扩展
    'myst_parser',
]

完成这两步后，ReadTheDocs就能正常解析Markdown格式的文档了。

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