html - 为什么 Github Pages 不提供我的文档？

Question

我使用 sphinx 来构建 html 文档，并且正在开源我公司的一些私人存储库。

在内部，我们通过 Cloudfront 从 S3 存储桶提供文档，因此我们可以将访问控制放在它前面。但对于开源，我认为通过 Github Pages 发布将是阻力最小的途径。

但是，我无法让服务正常工作。

这是我的 repo，我的 index.html 在 /docs 文件夹中。

这是该站点，它没有应用任何链接的 css，并且所有页面链接都已断开。

我试图通过仅使用已构建的文档制作测试仓库并从 master 发布来隔离问题。

正如你所看到的，这个甚至没有尝试提供 index.html，我只是得到一个 404 页面。

这些文件既可以在本地工作，也可以在从 AWS 提供服务时工作，所以我对 Github Pages 为什么不能正确提供服务感到有点茫然。我觉得我一定是在做某种愚蠢的疏忽。如果有更多经验的人可以看看并指出我的方式错误，我将不胜感激。我大部分时间都是后端工程师，所以网站逻辑有点超出我的正常驾驶室。提前致谢！

标签： htmlgithub-pages

Answer 1

对于遇到同样事情的其他人，我想通了。因为我在 CI/CD 管道中预先构建了站点，所以我不需要 jekyll 来为我构建站点，并且需要为其添加一个空的配置文件。

从 [这里][ https://www.docslikecode.com/articles/github-pages-python-sphinx/]：

接下来，您设置 .nojekyll 文件以表明您没有使用 Jekyll 作为此存储库中的静态站点生成器。

谢谢您的帮助！