Skip to main content

Sphinx document searcher using SQLite3.

Project description

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

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
]
  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

sphinx_sqlite3fts-0.1.2.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

sphinx_sqlite3fts-0.1.2-py2.py3-none-any.whl (12.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinx_sqlite3fts-0.1.2.tar.gz.

File metadata

  • Download URL: sphinx_sqlite3fts-0.1.2.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for sphinx_sqlite3fts-0.1.2.tar.gz
Algorithm Hash digest
SHA256 8c2a4e63bb5b4795bce1aaa5a59d9a4093a5b98eff755335b83a5cfd4b2d2da9
MD5 cc15b273fbe90da26291adaa55b89c4a
BLAKE2b-256 4887fd1c7ecff1dbb8cd8edccb2862b131ffb39212a0f2db77401a3a48d787d5

See more details on using hashes here.

File details

Details for the file sphinx_sqlite3fts-0.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_sqlite3fts-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8efdbfb174f383029dd2c2d6a6ab5b6c3f2a32fa945bc65b6811d96b006a0dbd
MD5 f7d640eb85e23f5bb5c4367d1814a811
BLAKE2b-256 86ccdcc6920365ac61b35dcfc788d6f3ccfb20c78aaece417954ecee0537ecf4

See more details on using hashes here.

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