python - 如何调整 Python Sphinx 以获得良好的网站搜索结果？

Question

我真的很喜欢 Python-Sphinx 文档工具，但让我烦恼的一件事是我几乎无法从 sphinx 搜索框中获得正确的搜索结果:

所以我想知道是否有什么技巧可以让 Sphinx 搜索框获得更好的搜索性能？另外，是否有任何工具可以让我用自定义 Google 搜索替换 Sphinx 搜索框？

谢谢!

编辑:我刚刚发现Scipy搜索框自动链接到谷歌。我想知道是否有人知道他们是如何实现这一目标的？

Answer 1

Google 搜索框的集成在 Sphinx 常见问题解答部分中有描述，您需要申请一个 Google 帐户。正如预期的那样，它对我有用。也许您可能需要调整 CSS Z-Index 以避免根据您的主题按内容覆盖搜索结果。

来自:https://www.sphinx-doc.org/en/master/faq.html?highlight=google%20search

Google 搜索

要将 Sphinx 的内置搜索功能替换为 Google 搜索，请按以下步骤操作:

1. 转到https://cse.google.com/cse/all创建 Google 搜索代码段。

2. 复制代码片段并将其粘贴到 Sphinx 项目中的 _templates/searchbox.html:

   <div>
      <h3>{{ _('Quick search') }}</h3>
      <script>
         (function() {
            var cx = '......';
            var gcse = document.createElement('script');
            gcse.type = 'text/javascript';
            gcse.async = true;
            gcse.src = 'https://cse.google.com/cse.js?cx=' + cx;
            var s = document.getElementsByTagName('script')[0];
            s.parentNode.insertBefore(gcse, s);
         })();
      </script>
     <gcse:search></gcse:search>
   </div>
   

3. 将 searchbox.html 添加到 html_sidebars 配置值。