public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Rito Rhymes <rito@ritovision.com>
To: corbet@lwn.net, skhan@linuxfoundation.org
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Rito Rhymes <rito@ritovision.com>
Subject: [PATCH v3 0/2] docs: advanced search with benchmark harness
Date: Sat,  4 Apr 2026 03:34:11 -0400	[thread overview]
Message-ID: <20260404073413.32309-1-rito@ritovision.com> (raw)
In-Reply-To: <20260321181511.11706-1-rito@ritovision.com>

This series adds an Advanced Search interface for kernel
documentation.

This is being proposed here rather than upstream Sphinx because the
current implementation is tailored to the kernel documentation set and
its navigation needs, and is integrated through kernel-local template
and static-asset overrides rather than a generalized Sphinx extension
interface.

Parts of the approach could potentially be abstracted further in the
future, but this series is focused on solving the problem concretely for
kernel documentation first rather than proposing a general-purpose
Sphinx search redesign.

The first patch adds the feature itself: an advanced search page built
on the existing Sphinx search data, with tabbed results for Symbols,
Sections, Index entries, and Pages, richer filtering, more targeted
identifier search, and bounded Pages summary loading with compatibility
handling across supported Sphinx versions.

The second patch adds optional developer-side benchmark tooling and
passive timing instrumentation used to validate runtime behavior and
compare advanced search with stock Quick Search.

Jon previously noted that the window for larger merges has passed, so
this is not intended as a request to take a large feature late in the
current cycle. The immediate goal is to close the loop on the debugging
and compatibility work around the earlier version, so the current
implementation is available for testing and review ahead of future
merge windows.

This version should address the compatibility issue Randy had reported
with the earlier implementation. If Randy has time to try this updated
version with the setup that exposed the earlier problem, I would
appreciate confirmation that it now behaves correctly there.

Rito Rhymes (2):
  docs: add advanced search for kernel documentation
  docs: add advanced search benchmark harness and instrumentation

 Documentation/doc-guide/sphinx.rst            |  100 ++
 Documentation/sphinx-static/custom.css        |  288 ++++
 Documentation/sphinx-static/kernel-search.js  | 1264 ++++++++++++++++
 Documentation/sphinx/templates/search.html    |  117 ++
 Documentation/sphinx/templates/searchbox.html |   30 +
 MAINTAINERS                                   |   11 +
 tools/docs/bench_search_playwright.mjs        | 1278 +++++++++++++++++
 tools/docs/test_advanced_search.py            |  312 ++++
 8 files changed, 3400 insertions(+)
 create mode 100644 Documentation/sphinx-static/kernel-search.js
 create mode 100644 Documentation/sphinx/templates/search.html
 create mode 100644 Documentation/sphinx/templates/searchbox.html
 create mode 100755 tools/docs/bench_search_playwright.mjs
 create mode 100755 tools/docs/test_advanced_search.py

-- 
2.51.0

  parent reply	other threads:[~2026-04-04  7:34 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-21 18:15 [PATCH] docs: add advanced search for kernel documentation Rito Rhymes
2026-03-21 22:53 ` Randy Dunlap
2026-03-21 23:15   ` Rito Rhymes
2026-03-21 23:59     ` Randy Dunlap
2026-03-22  1:12       ` Rito Rhymes
2026-03-22 19:59         ` Randy Dunlap
2026-03-23 22:50           ` Rito Rhymes
2026-03-23 23:01             ` Randy Dunlap
2026-03-28 20:55               ` Rito Rhymes
2026-03-22 16:01 ` Jonathan Corbet
2026-03-22 17:08   ` Rito Rhymes
2026-03-22 17:25     ` Rito Rhymes
2026-03-22 20:25     ` Jonathan Corbet
2026-03-22 18:17 ` [PATCH v2] " Rito Rhymes
2026-04-04  7:34 ` Rito Rhymes [this message]
2026-04-04  7:34   ` [PATCH v3 1/2] " Rito Rhymes
2026-04-04  7:34   ` [PATCH v3 2/2] docs: add advanced search benchmark harness and instrumentation Rito Rhymes
2026-04-05 12:43     ` kernel test robot
2026-04-04  7:50 ` [PATCH v3 0/2] docs: advanced search with benchmark harness Rito Rhymes
2026-04-05  5:51   ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260404073413.32309-1-rito@ritovision.com \
    --to=rito@ritovision.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox