是否需要安装Mkdocs来维护基于mkdocs的读文档项目？

Question

我安装了MkDocs，创建了一个本地项目，并将其上传到GitHub。然后，在读文档中，我创建了一个链接到Github回购设置为自动构建的项目。当我对Github中的文件进行更改时，输出看起来和预期的一样，并按预期进行更新。

现在，我对MkDocs未来的角色感到有点困惑。据我所知，无论是我还是其他想要contribute...we的人都不再需要它，只需要根据需要编辑/创建标记和github中的图像文件，读取文档就可以处理剩下的部分了？我认为安装MkDocs的唯一原因是，如果我(或项目的其他工作人员)希望在将编辑添加到github之前，运行本地MkDocs服务器来查看编辑是如何在本地呈现的。这是对的还是我遗漏了什么？

(安装MkDocs显然不是问题.我只是想知道发生了什么事。在你的回复中，请随心所欲地施舍.我是一位科技作家，而不是开发人员:-)

谢谢

Answer 1

除非您想在本地构建项目文档，否则不需要在本地安装MkDocs。读取文档将安装.readthedocs.yaml配置文件中指定的所有依赖项(请参阅https://docs.readthedocs.io/en/stable/config-file/v2.html#python)。

但是，即使没有指定构建文档的依赖项(例如MkDocs)的配置文件，读取文档也会安装一些强制依赖项来构建文档(例如MkDocs或狮身人面像)。这就是为什么当协作者编辑GitHub上的文件而没有在本地安装任何东西时，正确地反映读取文档上的更改。