Skip to main content

atsphinx-sqlite3fts

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

Metadata

Release files for atsphinx-sqlite3fts 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for atsphinx-sqlite3fts 0.1.4
File Size Uploaded
atsphinx_sqlite3fts-0.1.4.tar.gz 44.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for atsphinx-sqlite3fts 0.1.4
File Interpreter ABI Platform
atsphinx_sqlite3fts-0.1.4-py3-none-any.whl Python 3 none any Details

Total release size: 57.6 kB

Release files / atsphinx_sqlite3fts-0.1.4.tar.gz

Download URL atsphinx_sqlite3fts-0.1.4.tar.gz
Size 44.7 kB
Tags Source
SHA-256 checksum
How to use checksums
9e4977f15dce900e5f3fa69f34ff6fa34176af437771a2ffc3ec35a0d15b4810
BLAKE2b-256 checksum
How to use checksums
af4d6cc08f268d93b8b70560ec8b7793651e1fd412485f7fc6d203a3005914c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.6

Release files / atsphinx_sqlite3fts-0.1.4-py3-none-any.whl

Download URL atsphinx_sqlite3fts-0.1.4-py3-none-any.whl
Size 12.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
67098d2b174bc7ec994f290e3928de1e57e7ef503b506a37ca0984294d9fc270
BLAKE2b-256 checksum
How to use checksums
528f887bfc9d31c0b75d5c1d56ce3fd44eb580c49a20e99415b46e30c0033ab3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.6

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page