Skip to main content

Sphinx document searcher using SQLite3.

Project description

Power search for Sphinx by SQLite3-FTS extension.

https://img.shields.io/pypi/v/atsphinx-sqlite3fts.svg Run CI Documentation Status

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atsphinx_sqlite3fts-0.1.3.tar.gz (21.7 kB view hashes)

Uploaded Source

Built Distribution

atsphinx_sqlite3fts-0.1.3-py2.py3-none-any.whl (12.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page