【发布时间】:2022-07-18 23:19:04
【问题描述】:
我是第一次创建一个 python 包,在将我的文档上传到 readthedocs 时遇到了很多麻烦。我正在使用 mkdocs 来创建我的文档。当我运行mkdocs serve 命令时,我的文档会按照我想要的方式加载。但是,当我尝试将我的项目与 readthedocs 同步时,遇到了很多麻烦。构建是“成功的”,但我认为它正在构建,就好像它是用 sphinx 创建的(参见构建的屏幕截图)。我做了以下事情:
- 根据 mkdocs readthedocs 教程包含一个 .readthedocs.yml 文件
- 包含一个有效的 mkdocs.yml 文件
- 在高级设置中将文档类型设置为“Mkdocs”
我想不出会发生这种情况的其他原因。如果您有任何想法,请告诉我。谢谢!
【问题讨论】:
-
检查项目的构建日志是否有错误。提供带有代码的可重现示例,最好带有指向您的存储库的链接。其他 RTD:docs.readthedocs.io/en/stable/intro/…
标签: python markdown read-the-docs mkdocs