Skip to main content

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.4.tar.gz (44.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atsphinx_sqlite3fts-0.1.4-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file atsphinx_sqlite3fts-0.1.4.tar.gz.

File metadata

  • Download URL: atsphinx_sqlite3fts-0.1.4.tar.gz
  • Upload date:
  • Size: 44.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for atsphinx_sqlite3fts-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9e4977f15dce900e5f3fa69f34ff6fa34176af437771a2ffc3ec35a0d15b4810
MD5 40cc3294e0696ffcac9226732067b77b
BLAKE2b-256 af4d6cc08f268d93b8b70560ec8b7793651e1fd412485f7fc6d203a3005914c5

See more details on using hashes here.

File details

Details for the file atsphinx_sqlite3fts-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for atsphinx_sqlite3fts-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 67098d2b174bc7ec994f290e3928de1e57e7ef503b506a37ca0984294d9fc270
MD5 cac3cf87e2578bb2d880ed11d2a4ff4a
BLAKE2b-256 528f887bfc9d31c0b75d5c1d56ce3fd44eb580c49a20e99415b46e30c0033ab3

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 files

0.1.3

2 files

0.1.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page