Github 包含 Sphinx 生成文档的页面未正确显示 HTML

Github Pages with Sphinx generated documentation not displaying HTML correctly

我一直在尝试在 Github 页面上为我们的存储库发布 Sphinx 生成的文档,主题由 readthedocs.org 提供。

经过几次尝试,我设法通过将 Sphinx 生成的 HTML 文件上传到存储库的 gh-pages 分支中使其在线。

获得这个:

https://takeqontrol.github.io/qontrol_api/

这看起来很糟糕,通过阅读文档删除了主题的所有自定义设置。

这是您打开 link 时看到的示例:

但是如果我在我的计算机上打开那些 HTML 文件,页面看起来就像我想要的那样。 这是 HTML 在本地看起来完全相同的示例:

有人知道这是怎么回事吗?或者甚至指出我可以找到解释的地方?

所有代码都可以在这里找到:https://github.com/takeqontrol/qontrol_api 在两个分支中。

我遇到了类似的问题,然后找到了这个,为我解决了这个问题:

Python Sphinx css not working on github pages

问题似乎是对 _sources + _static 文件夹使用下划线。需要相应地重命名 html 文件中使用它们的文件夹和路径。

我为此苦苦挣扎了 9 个小时,才发现是 _static 文件夹中的 下划线 导致了这个问题。

你需要by pass Jekyll on github pages.

为此,请将一个空的 .nojekyll 添加到您的 gh-pages 分支。 (参见 example