The GitHub Actions job "Tests" on airflow.git/main has failed.
Run started by GitHub user potiuk (triggered by potiuk).

Head commit for run:
d0bd2df6d194a8b923fb55b2f37107642c261b40 / Kaxil Naik <[email protected]>
Add fast client-side search to Airflow documentation (#59658)

I have been frustrated by Sphinx search for a long-long time. So after adding 
dark-mode, this was next in my list!

This PR/commit introduces a fast, fully client-side search experience for the 
Apache Airflow documentation, powered by [Pagefind](https://pagefind.app/). The 
new search is keyboard-accessible (Cmd+K / Ctrl+K), works offline, and requires 
no external services.

Search indexes are generated automatically at documentation build time and 
loaded entirely in the browser, enabling sub-50 ms queries even on large docs.

I have kept the Sphinx search too as a backup and it will keep functioning.

----

Add keyboard-accessible search (Cmd+K) to Apache Airflow documentation with
automatic indexing and offline support.

New Sphinx extension: `pagefind_search`

Located in `devel-common/src/sphinx_exts/pagefind_search/`:
- __init__.py: Extension setup with configuration values and event handlers
- builder.py: Automatic index building with graceful fallback
- static/css/pagefind.css: Search modal and button styling with dark mode 
support
- static/js/search.js: Search functionality with keyboard shortcuts
- templates/search-modal.html: Search modal HTML template

- Keyboard shortcut (Cmd+K/Ctrl+K) opens search modal
- Arrow key navigation through results
- Works offline (no external services)
- Automatic indexing during documentation build
- Dark mode support
- Sub-50ms search performance
- Configurable content indexing via conf.py

Users can now:
- Press Cmd+K from any documentation page to search
- Navigate results with arrow keys, Enter to select, Esc to close
- Search works immediately without network requests
- Results show page title, breadcrumb, and excerpt

Available in conf.py:
- pagefind_enabled: Toggle search indexing
- pagefind_verbose: Enable build logging
- pagefind_root_selector: Define searchable content area
- pagefind_exclude_selectors: Exclude navigation, headers, footers
- pagefind_custom_records: Index non-HTML content (PDFs, etc.)

Report URL: https://github.com/apache/airflow/actions/runs/20395146430

With regards,
GitHub Actions via GitBox


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to