如何将搜索结果限制在RTD手册的某些部分



我们使用RTD为我们的项目生成文档。该文档由两个主要部分组成:书籍风格的章节;一方面是部分,另一方面是从代码中提取的自动生成文档。

我们发现,人们通常只想搜索两者中的一个,但不想同时搜索两者。有没有办法建立这种机制,或者巧妙地利用现有的机制来做到这一点?搜索框中的一种关键字或说明符是理想的。

供参考:完整的文档和自动生成的零件。

目前这是不可能的,但我们正在考虑https://github.com/readthedocs/readthedocs.org/issues/5966.

同时,Steve的解决方案如何将搜索结果限制在RTD手册的某些部分?是一个很好的变通方法。他们使用的是Sphinx的searchtools.js的补丁版本https://github.com/plone/documentation/blob/7dc58219ee75129831a481f24849defcd8b290bd/docs/_static/searchtools.js#L225-L231.

与上述类似的另一个解决方案可以使用我们的API实现https://docs.readthedocs.io/en/stable/server-side-search.html#get--api-v2-搜索-并过滤结果客户端(这是使用每个结果的path属性(

最新更新