为Readthedocs的单独URL构建单独的主题

时间:2019-06-08 01:59:38

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

我正在寻找一种解决方案,该解决方案允许我们根据网址通过rtd在构建的文档中使用单独的主题。该项目是github托管的,因此我们在其中使用rtd的Webhook集成。

基本上,我们希望 slug .readthedocs.io使用默认值,并通过rtd拥有一个自定义域,即docs.ourdomain.org,使用主题样式来匹配我们的网站

on_rtd似乎是rtd生成文档时的True,所以这可能没有用,但是如果我错了,请纠正我。

也许有多个Webhooks?我还没有发现一些sphinx的魔法?

考虑使用分支或标签,但这似乎有点多,而且我认为,这将要求在rtd上进行多个项目命名。不过,如果我错了,请纠正我。

目前,我们已经实现了网站主题化,并且只是将两者都实现了,但是理想情况下,我们希望 slug .readthedocs.io网站更加通用并且符合readthedocs.io的感觉。

1 个答案:

答案 0 :(得分:0)

目前,Read the Docs不支持给定回购/分支的多个主题。

这里至少有几种方法。

1)使用分支托管替代文档。阅读文档,这里有一个示例项目,说明了这种方法:

2)使用sub-projects

这两个方法都没有真正直接解决我的问题 中的用例,但是它们确实为多种主题提供了一种替代方法。