【问题标题】:How do I customize Sphinx RtD Theme default search settings?如何自定义 Sphinx RtD Theme 默认搜索设置?
【发布时间】:2017-05-24 09:22:32
【问题描述】:

如何覆盖 Sphinx RTD 主题附带的默认搜索 html。我在 Sphinx 1.5 上,主题始终是导入的,而不是静态的。

【问题讨论】:

  • 不清楚。您要更新搜索结果中生成的 HTML 还是主题中的 CSS?
  • 是的。我们希望有一个更好的搜索过滤器。我们需要编辑 Search.html。

标签: python-sphinx read-the-docs


【解决方案1】:

请参阅 Sphinx 文档中的 Templating

要自定义文档的输出,您可以通过将与原始文件名同名的文件添加到 Sphinx 快速入门为您生成的结构的模板目录中来覆盖所有模板(布局模板和子模板) .

Sphinx 将首先在 templates_path 的文件夹中查找模板,如果在其中找不到它正在寻找的模板,它会回退到所选主题的模板。

在您的情况下,将 RTD Sphinx 主题的 search.html 从您安装的包中复制到您的模板目录中,然后根据自己的喜好进行修改。然后将您的conf.py 中的templates_path 的值设置为它的位置。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2011-08-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2019-12-16
    • 1970-01-01
    相关资源
    最近更新 更多