doc: Add Google Programmable Search Engine
Add Google Programmable Search engine to the documentation, while leaving it possible to easily revert to the built-in Sphinx search engine. As the styling of the search results is apparently not thought to be easy to tweak, the gcs.css stylesheet might require further improvements. Fixes #55173. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé
Anas Nashif
parent
fc0a9c5655
commit
7688f4859c
3 changed files with 134 additions and 1 deletions
101
doc/_static/css/gcs.css
vendored
Normal file
101
doc/_static/css/gcs.css
vendored
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
/**
|
||||
* Copyright (c) 2023, Benjamin Cabé <benjamin@zephyrproject.org>.
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*
|
||||
* Custom stylesheet for Google Programmable Search Engine results.
|
||||
*/
|
||||
|
||||
.gs-webResult .gs-snippet,
|
||||
.gs-fileFormatType,
|
||||
.gs-spelling,
|
||||
.gsc-refinementHeader,
|
||||
.gsc-result-info,
|
||||
.gsc-orderby-label {
|
||||
color: var(--body-color) !important;
|
||||
}
|
||||
|
||||
.gsc-control-cse {
|
||||
width: 100%;
|
||||
padding: 0 !important;
|
||||
font-family: inherit !important;
|
||||
font-size: inherit !important;
|
||||
background-color: inherit !important;
|
||||
border: none !important;
|
||||
font-size: inherit !important;
|
||||
}
|
||||
|
||||
.gsc-completion-container {
|
||||
font-family: inherit !important;
|
||||
}
|
||||
|
||||
.gs-result .gs-title, .gs-result .gs-title * {
|
||||
color: var(--link-color) !important;
|
||||
background-color: var(--content-background-color) !important;
|
||||
}
|
||||
|
||||
.gs-result .gs-title:visited, .gs-result .gs-title:visited * {
|
||||
color: var(--link-color-visited) !important;
|
||||
}
|
||||
|
||||
.gsc-results .gsc-cursor-box .gsc-cursor-page,
|
||||
.gsc-results .gsc-cursor-box .gsc-cursor-current-page {
|
||||
background-color: var(--content-background-color) !important;
|
||||
color: var(--link-color) !important;
|
||||
}
|
||||
|
||||
.gs-result .gs-image, .gs-result .gs-promotion-image {
|
||||
border: none !important;
|
||||
padding-right: .5em;
|
||||
}
|
||||
|
||||
.gsc-table-result {
|
||||
font-family: inherit !important;
|
||||
padding-top: .5em !important;
|
||||
font-size: inherit !important;
|
||||
}
|
||||
|
||||
.gsc-tabHeader.gsc-tabhActive, .gsc-refinementHeader.gsc-refinementhActive,
|
||||
.gsc-tabHeader.gsc-tabhInactive, .gsc-refinementHeader.gsc-refinementhInactive {
|
||||
background-color: inherit !important;
|
||||
}
|
||||
|
||||
.gs-no-results-result .gs-snippet, .gs-error-result .gs-snippet {
|
||||
color: var(--admonition-attention-title-color) !important;
|
||||
background-color: var(--admonition-attention-title-background-color) !important;
|
||||
}
|
||||
|
||||
.gsc-webResult .gsc-result {
|
||||
background-color: inherit !important;
|
||||
margin: 0;
|
||||
padding: .5em 0;
|
||||
border: none !important;
|
||||
border-bottom: 1px solid var(--hr-color) !important;
|
||||
}
|
||||
|
||||
.gs-webResult div.gs-per-result-labels {
|
||||
margin-top: 1.3em;
|
||||
margin-bottom: 0.3em;
|
||||
font-size:0.8em;
|
||||
}
|
||||
|
||||
.gs-webResult div.gs-per-result-labels span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.gs-webResult div.gs-per-result-labels a.gs-label {
|
||||
text-decoration: none !important;
|
||||
cursor: pointer;
|
||||
padding: 0.4em 0.6em;
|
||||
margin-left: .5em;
|
||||
color: var(--admonition-tip-title-color) !important;
|
||||
background-color: var(--admonition-tip-title-background-color) !important;
|
||||
border-radius: 50px;
|
||||
}
|
||||
|
||||
.gcsc-find-more-on-google {
|
||||
color: var(--link-color) !important;
|
||||
}
|
||||
|
||||
.gcsc-find-more-on-google-magnifier {
|
||||
fill: var(--link-color) !important;
|
||||
}
|
||||
28
doc/_templates/search.html
vendored
Normal file
28
doc/_templates/search.html
vendored
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
{%- extends "!search.html" %}
|
||||
{%- block scripts %}
|
||||
{% if google_searchengine_id %}
|
||||
{{ super.super() }}
|
||||
<link rel="stylesheet" href="{{ pathto('_static/css/gcs.css', 1) }}" type="text/css" />
|
||||
{% else %}
|
||||
{{ super() }}
|
||||
{% endif %}
|
||||
{%- endblock %}
|
||||
|
||||
{% block footer %}
|
||||
{% if google_searchengine_id %}
|
||||
{{ super.super() }}
|
||||
{% else %}
|
||||
{{ super() }}
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block body %}
|
||||
{% if google_searchengine_id %}
|
||||
<h2>{{ _('Search Results') }}</h2>
|
||||
<script async src="https://cse.google.com/cse.js?cx={{ google_searchengine_id }}">
|
||||
</script>
|
||||
<div class="gcse-searchresults-only"></div>
|
||||
{% else %}
|
||||
{{ super() }}
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
|
@ -176,7 +176,11 @@ html_context = {
|
|||
"Kconfig Options": f"{reference_prefix}/kconfig.html",
|
||||
"Devicetree Bindings": f"{reference_prefix}/build/dts/api/bindings.html",
|
||||
"West Projects": f"{reference_prefix}/develop/manifest/index.html",
|
||||
}
|
||||
},
|
||||
# Set google_searchengine_id to your Search Engine ID to replace built-in search
|
||||
# engine with Google's Programmable Search Engine.
|
||||
# See https://programmablesearchengine.google.com/ for details.
|
||||
"google_searchengine_id": "746031aa0d56d4912",
|
||||
}
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
|
|
|||
Loading…
Reference in a new issue