atsphinx.toybox.lindera_search

Note

Added by v2024.12.10

Overview

This is to use Lindera search components of Sphinx.

Usage

Install requires

This extension requires optional installation. Please add ‘lindera-search’ option when you install it.

pip install 'atsphinx-toybox[lindera-search]'

Set configuration

Add this into your conf.py of Sphinx.

conf.py

html_search_options = {
    "type": "atsphinx.toybox.lindera_search.LinderaSplitter",
}

Demo

Refs

• lindera-py