Skip to content

atsphinx/sqlite3fts

 
 

Repository files navigation

atsphinx-sqlite3fts

Power search for Sphinx by SQLite3-FTS extension.

image

Run CI

Documentation Status

Note

This is experimental library

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

pip install atsphinx-sqlite3fts

Usage

  1. Register extension into your conf.py and configure it.
extensions = [
    #
    # Other extensions
    #
    "atsphinx.sqlite3fts",  # Add it
]
  1. Run builder (html-based builder only).
sphinx-build -M html source build
  1. To try it in local, use http.server module.
python -m http.server -d build

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

About

Power search for Sphinx by SQLite3-FTS extension.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 72.1%
  • JavaScript 27.9%