带有 Sphinx 生成的文档的 Github 页面无法正确显示 HTML

Raf*_*Raf 12 github python-sphinx github-pages read-the-docs

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

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

获得这个:

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

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

以下是打开链接时看到的示例:

出现在 githubpages 中的 html - 缺少所有自定义

但是如果我在我的计算机上打开这些 HTML 文件,页面看起来正是我想要的样子。下面是一个示例,说明完全相同的 HTML 在本地的外观:

HTML 显示在浏览器本地,具有所有必需的自定义

有人知道发生了什么吗?或者甚至指出我可以找到解释的地方?

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

K.S*_*.S. 6

我找出了之前与此打9小时下划线的在_static文件夹中引起问题。

你需要绕过 github pages 上的 Jekyll

为此,请.nojekyll向您的gh-pages分支添加一个空的。(见示例

  • [`sphinx.ext.githubpages`](https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html) Sphinx 扩展似乎有助于自动化此操作。 (2认同)