README.rst

sphinx-sqlite3fts

Sphinx new search page using SQL.js and SQLite database included FTS extension.

Note

This is migrated to atsphinx-sqlite3fts, and it stop manintenance.

Overview

This is sphinx extension to provide search component with full-text search database.

When sphinx-build runs with this extension, builder generate these components.

• SQLite database with FTS extension
• Records of all documents
• Search page HTML with sql.js

This will be useful when you want to embed strong full-text search with keeping static-site structure.

Installation

This is not published on PyPI.

pip install git+https://github.com/attakei-lab/sphinx-sqlite3fts.git

Usage

1. Register extension into your conf.py and configure it.

extensions = [
    #
    # Other extensions
    #
    "sphinx_sqlite3fts",  # Add it
]

2. Run builder (html-based builder only).

sphinx-build -M html source build

3. To try it in local, use http.server module.

 python -m http.server -d build

Please access http://localhost:8000/search.html