sphinx_rtd_theme未应用于ReadTheDocs版本,但本地版本工作正常

时间:2017-04-23 13:27:00

标签: themes python-sphinx read-the-docs

我面临一个奇怪的问题。我将最新的sphinx_rtd_theme文件添加到我的项目中,并完成了所需的主题覆盖(包括表中已知的文本包装)。

本地构建工作绝对正常。但是它被推到了主人身上,主题又回到了基础,并没有得到应用。我尝试过手动构建,但仍无法追查根本原因和解决方法。

通过master,我的意思是在ReadTheDocs网站(帐户)上创建的构建。

2 个答案:

答案 0 :(得分:0)

ReadTheDocs不会清除每个新构建的构建目录。我通过手动清除ReadTheDocs中的所有临时文件来修复它:

  • 所有构建目录
  • 从autoapi插件创建内容

之后,我修改的RTD主题用于新版本。

为此,我在conf.py中添加了标签检测。如果设置了我的标签,它会进行清理。您可以在ReadTheDocs Web UI中设置用户定义的标签。

答案 1 :(得分:0)

根据您的RTD Versions,"最新"指向项目文档的主分支。我查看了conf.py on the master branch的来源,并将其设置为主题ra。因此,无论您在本地做什么,都不会被推到RTD用于构建文档的同一分支。

在您执行任何其他操作之前,请确保您在本地进行的任何更改,推送到您的组织仓库,以及RTD从中构建文档的所有内容都在相同的分支上。

一旦您对其进行了排序,并假设您想在RTD和本地使用rtd_sphinx_theme,并且您还希望其他开发人员能够重现文档,请按照sphinx_rtd_theme installation via package method进行操作。