1
0
mirror of https://github.com/opencv/opencv.git synced 2026-07-24 21:03:03 +04:00
Files
omrope79 04aee009aa Merge pull request #29220 from omrope79:doc_optimizations_v4
[FOLLOW UP] : Documentation optimizations for the new Sphinx structure #29220

### Pull Request Readiness Checklist

This PR serves as a follow-up to the new documentation system introduced in [#29206](https://github.com/opencv/opencv/pull/29206)
Co-authored by: @abhishek-gola @kirtijindal14 @Akansha-977 @Prasadayus @varun-jaiswal17

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

- [x] I agree to contribute to the project under Apache 2 License.
- [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
- [x] The PR is proposed to the proper branch
- [x] There is a reference to the original bug report and related work
- [x] There is accuracy test, performance test and test data in opencv_extra repository, if applicable
      Patch to opencv_extra has the same branch name.
- [x] The feature is well documented and sample code can be built with the project CMake
2026-06-05 14:18:27 +03:00

147 lines
6.8 KiB
HTML

{% extends "!layout.html" %}
{%- set _doxy = ('../' * ((pagename or '').count('/') + 2)) ~ 'doc/doxygen/html/' %}
{%- set _search = _doxy ~ 'search/' %}
{% block extrahead %}
{{ super() }}
<link rel="stylesheet" href="{{ _search }}search.css"/>
<script src="{{ pathto('_static/search_map.js', 1) }}"></script>
<script src="{{ _doxy }}cookie.js"></script>
<script src="{{ _search }}searchdata.js"></script>
<script src="{{ _search }}search.js"></script>
<script>
// SearchBox lives in search.js; guard so a load failure can't abort this
// script (which would leave the modal trigger unwired).
var searchBox;
try { searchBox = new SearchBox("searchBox", "{{ _search }}", '.html'); } catch (e) {}
// Open/close the centered modal. Defined early so the Ctrl+K handler can use
// them, and kept independent of the Doxygen backend so opening always works.
function opencvOpenSearch() {
var ov = document.getElementById("opencvSearchOverlay");
if (!ov) return;
ov.classList.add("opencv-search-open");
var f = document.getElementById("MSearchField");
if (f) { f.focus(); f.select(); }
}
function opencvCloseSearch() {
var ov = document.getElementById("opencvSearchOverlay");
if (ov) ov.classList.remove("opencv-search-open");
if (window.searchBox && searchBox.CloseResultsWindow) searchBox.CloseResultsWindow();
}
// Win Ctrl+K over the theme's deferred handler + the browser (registered
// before the theme's, so stopImmediatePropagation pre-empts it).
window.addEventListener("keydown", function (e) {
if ((e.ctrlKey || e.metaKey) && !e.shiftKey && !e.altKey && /^k$/i.test(e.key)) {
e.preventDefault();
e.stopImmediatePropagation();
opencvOpenSearch();
}
}, true);
document.addEventListener("DOMContentLoaded", function () {
// The theme renders navbar_end twice (desktop header + mobile drawer), so
// the search component appears twice → duplicate #opencvSearchTrigger /
// #opencvSearchOverlay IDs. Keep ONE overlay; wire EVERY trigger to it
// (the visible button may be the second copy — getElementById sees only the
// first, which is why clicking did nothing before).
var overlays = document.querySelectorAll("#opencvSearchOverlay");
for (var k = overlays.length - 1; k >= 1; k--) overlays[k].parentNode.removeChild(overlays[k]);
var overlay = overlays[0];
if (overlay && overlay.parentNode !== document.body) document.body.appendChild(overlay);
// 1) Wire opening FIRST so the modal works even if Doxygen init throws.
document.querySelectorAll("#opencvSearchTrigger").forEach(function (btn) {
btn.addEventListener("click", function (e) { e.preventDefault(); opencvOpenSearch(); });
});
if (overlay) overlay.addEventListener("mousedown", function (e) { if (e.target === overlay) opencvCloseSearch(); });
document.addEventListener("keydown", function (e) { if (/^Escape$/i.test(e.key)) opencvCloseSearch(); });
// 2) Doxygen search backend (guarded: a failure must not break typing).
try {
var boxes = document.querySelectorAll("#MSearchBox");
for (var i = 1; i < boxes.length; i++) boxes[i].remove();
var sel = document.createElement("div");
sel.id = "MSearchSelectWindow";
sel.setAttribute("onmouseover", "return searchBox.OnSearchSelectShow()");
sel.setAttribute("onmouseout", "return searchBox.OnSearchSelectHide()");
sel.setAttribute("onkeydown", "return searchBox.OnSearchSelectKey(event)");
document.body.appendChild(sel);
var res = document.createElement("div");
res.id = "MSearchResultsWindow";
res.innerHTML = '<div id="MSearchResults"><div class="SRPage"><div id="SRIndex">' +
'<div id="SRResults"></div>' +
'<div class="SRStatus" id="Loading">Loading...</div>' +
'<div class="SRStatus" id="Searching">Searching...</div>' +
'<div class="SRStatus" id="NoMatches">No Matches</div></div></div></div>';
document.body.appendChild(res);
init_search();
searchBox.OnSelectItem(0); // default to "All" on every page load
var sphinxRoot = "{{ '../' * (pagename or '').count('/') }}";
// Doxygen result href -> Sphinx page, or "" if that page is not in our build.
function resolveSphinx(href) {
if (!href || href.indexOf("javascript:") === 0) return "";
var map = (typeof sphinxPageMap !== "undefined") ? sphinxPageMap : {};
var stem = href.split("/").pop().replace(/#.*$/, "").replace(/\.html$/, "");
var key = stem.replace(/^group__/, "").replace(/^tutorial_/, "").replace(/__/g, "_");
var path = map[stem] || map[key];
if (!path && stem.indexOf("namespace") === 0) path = map["core_basic"];
var rest = stem;
while (!path && rest.indexOf("_1_1") >= 0) {
rest = rest.substring(0, rest.lastIndexOf("_1_1"));
path = map[rest];
}
return path || "";
}
document.body.addEventListener("click", function (e) {
var a = e.target.closest ? e.target.closest("a.SRSymbol, a.SRScope") : null;
if (!a) return;
var href = a.getAttribute("href") || "";
var sphinxPath = resolveSphinx(href);
if (sphinxPath) {
e.preventDefault();
e.stopPropagation();
// Doxygen #autotoc_md anchors don't exist in Sphinx; rebuild from heading text.
var frag = "";
if (/#autotoc_md/.test(href)) {
var slug = (a.textContent || "").trim().toLowerCase()
.replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
if (slug) frag = "#" + slug;
}
window.location.href = sphinxRoot + sphinxPath + frag;
} else if (href.indexOf("doc/doxygen/html/") >= 0) {
e.preventDefault();
e.stopPropagation();
}
}, true);
// Pin the Doxygen popups under the (centered) box with position:fixed
// (Doxygen places them absolute at document-top → off-screen here).
var box = boxes[0];
function pin(w, left) {
if (!box) return;
var r = box.getBoundingClientRect();
w.style.setProperty("position", "fixed", "important");
w.style.setProperty("top", (r.bottom + 4) + "px", "important");
var x = left ? r.left : Math.max(8, r.right - (w.offsetWidth || 300));
w.style.setProperty("left", x + "px", "important");
}
[[res, false], [sel, true]].forEach(function (p) {
var w = p[0], opt = { attributes: true, attributeFilter: ["style"] };
var obs = new MutationObserver(function () {
if (w.style.display === "block") { obs.disconnect(); pin(w, p[1]); obs.observe(w, opt); }
});
obs.observe(w, opt);
});
} catch (err) {
if (window.console) console.error("Doxygen search init failed:", err);
}
});
</script>
{% endblock %}