内置于 Readthedocs 中的 MkDocs
我正在使用MKDocs准备文档，并尝试使用ReadThedocs生成文档。我遵循了用户指南，但是读取的thedocs似乎与我的github项目中上传的.md文件没有通信。 ReadThedocs生成的文档说，而不是阅读我的文档/index.md文件
这是一个自动化索引文件。
请创建
index.rst或readme.rst用root（或/docs）目录中的您自己的内容的文件存储库。如果要使用其他标记，请在设置中选择其他建筑商。查看我们的入门指南，以更熟悉阅读文档。
©版权所有2022。修订
8D3F60C9。
一个可能的问题是，构建器是Sphink而不是MKDOC，因此我将文档类型更改为Admin-＆GT中的“ MKDOC”；高级设置; readThedocs中的文档类型，但这并不能解决问题。
然后，我遵循有关以mkdocs的开始， ，导入文档=“ https://docs.readthedocs.io/en/stable/config-file/v2.html” rel =“ nofollow noreferrer”> configuration files MKDocs以设置配置文件以及无需他们工作。
如果有人可以帮助我解决这个问题，将不胜感激。
我进一步导航到 https：///shaarp-single-interface.readthedocs。 io/en/最终/readme.html 。
上面链接中的结构确实包含了我想要的所有导航面板，但是此页面不再维护readThedocs主题。
shaarp_single-interface 搜索文档 家 安装和设置 模拟和分析方法 输入参数 输出结果 示例
shaarp_single-interface 文档» 404 找不到页面
使用读取文档提供的主题构建的MKDOC。
但是，如果使用ReadThedocs中的“查看文档”访问文档，它将我指导我 https ：//shaarp-single-interface.readthedocs.io/en/latest/ ，它不包含我准备的任何面板。
I am preparing documentation using MkDocs and trying to generate the documentation using readthedocs. I followed the user guide but readthedocs does not seem to communicate with my uploaded .md files in my GitHub project. Instead of reading my docs/index.md file, the document generated by readthedocs says
This is an autogenerated index file.
Please create an
index.rstorREADME.rstfile with your own content under the root (or/docs) directory in your repository.If you want to use another markup, choose a different builder in your settings. Check out our Getting Started Guide to become more familiar with Read the Docs.
© Copyright 2022. Revision
8d3f60c9.
One possible issue is that the builder is Sphink instead of MkDocs, so I changed the document type to "MkDocs" in admin-> advanced setting->documentation type in readthedocs but this does not solve the issue.
I then followed the instruction in readthedocs about getting started with mkdocs, import documentation, and configuration files for Mkdocs to set up configuration files as well as requirements but none of them work.
It would be much appreciated if anyone could help me resolve this issue.
I further navigated to https://shaarp-single-interface.readthedocs.io/en/latest/README.html.
The structure in the link above does contain all the nav panels I want but this page no longer maintains the readthedocs theme.
SHAARP_Single-Interface
Search docs
Home
Installation and Setup
Simulation and Analytical Methods
Input Parameters
Output Results
Examples
SHAARP_Single-Interface
Docs »
404
Page not found
Built with MkDocs using a theme provided by Read the Docs.
However, if accessing the docs using "view docs" in readthedocs, it directs me to https://shaarp-single-interface.readthedocs.io/en/latest/, which does not contain any panel I have prepared.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
看起来构建过程很好，但文档需要一些时间（可能 1-2 小时）来更新。
也报告了类似的问题。 readthedocs 中自动生成的索引文件
It seems that the building process was fine but the docs will need some time (maybe 1-2 hours) to update.
A similar issue was reported. Autogenerated index file in readthedocs