sphinx_rtd_theme 未应用于 ReadTheDocs 构建,但本地构建工作正常
sphinx_rtd_theme is not getting applied on the ReadTheDocs builds but local builds work fine
我遇到了一个奇怪的问题。我将最新的 sphinx_rtd_theme 文件添加到我的项目中,并进行了所需的主题覆盖(包括表格中众所周知的文本换行)。
本地构建工作得很好。但是它被推给了主人,主题回到了非常基本的状态并且没有得到应用。我尝试了手动构建,但仍然无法追踪根本原因和解决方法。
大师,我指的是在 ReadTheDocs 网站(帐户)上创建的构建。
ReadTheDocs 不会清除每个新构建的构建目录。我通过手动清除 ReadTheDocs 中的所有临时文件来修复它:
- 所有构建目录
- 从 autoapi 插件创建内容
之后,我修改的 RTD 主题被用于新版本。
为此,我在 conf.py 中添加了标签检测。如果设置了我的标签,它会进行清理。您可以在 ReadTheDocs web UI.
中设置用户定义的标签
根据你的RTD Versions, "latest" points to the master branch of your project's documentation. I looked at the source of conf.py
on the master branch,设置为主题ra
。因此,无论您在本地做什么,都不会被推送到 RTD 用于构建文档的同一分支。
在你做任何其他事情之前,确保你在本地所做的任何更改,推送到你的组织存储库,以及 RTD 从中提取以构建文档都在相同的分支.
一旦你得到排序,并假设你想在 RTD 和本地使用 rtd_sphinx_theme
,并且你还希望其他开发人员能够复制文档,然后按照 sphinx_rtd_theme
installation via package method.
我遇到了一个奇怪的问题。我将最新的 sphinx_rtd_theme 文件添加到我的项目中,并进行了所需的主题覆盖(包括表格中众所周知的文本换行)。
本地构建工作得很好。但是它被推给了主人,主题回到了非常基本的状态并且没有得到应用。我尝试了手动构建,但仍然无法追踪根本原因和解决方法。
大师,我指的是在 ReadTheDocs 网站(帐户)上创建的构建。
ReadTheDocs 不会清除每个新构建的构建目录。我通过手动清除 ReadTheDocs 中的所有临时文件来修复它:
- 所有构建目录
- 从 autoapi 插件创建内容
之后,我修改的 RTD 主题被用于新版本。
为此,我在 conf.py 中添加了标签检测。如果设置了我的标签,它会进行清理。您可以在 ReadTheDocs web UI.
中设置用户定义的标签根据你的RTD Versions, "latest" points to the master branch of your project's documentation. I looked at the source of conf.py
on the master branch,设置为主题ra
。因此,无论您在本地做什么,都不会被推送到 RTD 用于构建文档的同一分支。
在你做任何其他事情之前,确保你在本地所做的任何更改,推送到你的组织存储库,以及 RTD 从中提取以构建文档都在相同的分支.
一旦你得到排序,并假设你想在 RTD 和本地使用 rtd_sphinx_theme
,并且你还希望其他开发人员能够复制文档,然后按照 sphinx_rtd_theme
installation via package method.