2017-04-23 66 views
1

我正面临一个奇怪的问题。我将最新的sphinx_rtd_theme文件添加到我的项目中,并完成了所需的主题覆盖(包括表格中众所周知的文字换行)。sphinx_rtd_theme未在ReadTheDocs版本上应用,但本地版本正常工作

本地构建工作绝对好。但它被推到了主人手中,这个主题回到了非常基本的层面,并没有得到应用。我尝试了手动构建,但仍无法追查根本原因和解决方法。

通过主人,我的意思是在ReadTheDocs网站(帐户)上创建的版本。

+0

您是否按照本地回购的[RTD主题安装说明](https://github.com/rtfd/sphinx_rtd_theme#installation)?如果您正确遵循这些说明,以及RTD对[webhooks](http://docs.readthedocs.io/en/latest/webhooks.html)和[入门](http://docs.readthedocs.io /en/latest/getting_started.html),那么它应该Just Work™。否则,您必须发布指向您的RTD构建页面的链接以进行故障排除。 –

+0

@Steve Piercy - 感谢您的回复。我们已经使用Sphinx超过4年了。主题总是ra。 直到最近我们才想到使用sphinx_rtd_theme。本地构建工作得很好,但它不在ReadTheDocs Repo上。 我不确定ReadTheDocs结尾需要什么额外设置才能配置? – veenamj

+0

没有更多信息,任何人都无法做到帮助你。你能发布一个链接到你的RTD构建页面吗?这是一个[金字塔的例子](http://readthedocs.org/projects/pyramid/builds/)。从那里,人们可以确切地看到在构建过程中发生了什么,看到你的主题“回到非常基本”的含义以及其他相关信息。 –

回答

0

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

在您做任何事情之前,请确保您在本地进行的任何更改,推送到您的组织回购,并且RTD从生成文档都在同一分支

一旦你得到的排序,并假设你想要同时使用的RTD和当地rtd_sphinx_theme,而你也希望其他开发人员能够重现的文档,然后按照sphinx_rtd_theme installation via package method

+0

不,实际上,反映在主人身上的conf.py以'ra'为主题。这是因为我回到了旧版本。我使用分支中的sphinx_rtd_theme更改conf.py,然后将其与主分支合并。在我推进更改后,构建会触发。但是这并没有带来新的主题。我用sphinx_rtd_theme得到的输出甚至没有设置'ra'主题。它回到只是一个html主题列表(一个非常基本的主题)。这是问题。 – veenamj

+0

我在通过软件包方法安装Sphinx RTD主题后得到错误内容后立即回答了这个问题。 @Steve - 再次感谢您的提示。我通过Package安装了新的主题。像往常一样,本地构建工作得很好,但我又一次获得了[RTD构建中的NoTheme](https://readthedocs.org/projects/qubole-documentation/builds/5339279/)。 Webhook在bitbucket上配置,其他更改在RTD帐户完成。是否有必要在requirements.txt文件中添加任何内容?我意识到我忘记添加html_theme_options,但添加了选项值。 – veenamj

+0

而不是经常修改您的主分支,创建一个测试分支的开发,并配置RTD来构建该分支。然后我们都在看同样的事情。我无法碰到移动的目标。 –

0

ReadTheDocs不会清除每个新版本上的构建目录。我固定它由ReadTheDocs手动清洁所有的临时文件:

  • 都建立目录从autoapi插件

之后

  • 创建的内容,用于新建立我的修改RTD主题。

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

  • +0

    非常感谢!如何清理ReadTheDocs中的临时文件。该构建是实时的,并且文档始终由用户访问。我该怎么做? – veenamj

    +0

    您可以在conf.py中添加一些删除指令。在启用标记值的情况下运行一次,以清除所有内容,然后删除标记值,然后再次触发构建。它只有几分钟在线。我只需要这个程序一次。 – Paebbels

    +0

    嗨, 我刚刚发现项目/ /版本页面中的非活动版本。 每个非活动版本都有一个擦除按钮。我应该只是消灭不活动的版本并重建我的主分支? – veenamj

    相关问题