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
Register extension into your conf.py and configure it.
extensions = [
#
# Other extensions
#
"sphinx_sqlite3fts", # Add it
]
Run builder (html-based builder only).
sphinx-build -M html source build
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 sphinx-sqlite3fts 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_sqlite3fts-0.1.2.tar.gz | 21.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_sqlite3fts-0.1.2-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 34.2 kB
Release files / sphinx_sqlite3fts-0.1.2.tar.gz
| Download URL | sphinx_sqlite3fts-0.1.2.tar.gz |
|---|---|
| Size | 21.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8c2a4e63bb5b4795bce1aaa5a59d9a4093a5b98eff755335b83a5cfd4b2d2da9
|
|
BLAKE2b-256 checksum How to use checksums |
4887fd1c7ecff1dbb8cd8edccb2862b131ffb39212a0f2db77401a3a48d787d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Release files / sphinx_sqlite3fts-0.1.2-py2.py3-none-any.whl
| Download URL | sphinx_sqlite3fts-0.1.2-py2.py3-none-any.whl |
|---|---|
| Size | 12.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
8efdbfb174f383029dd2c2d6a6ab5b6c3f2a32fa945bc65b6811d96b006a0dbd
|
|
BLAKE2b-256 checksum How to use checksums |
86ccdcc6920365ac61b35dcfc788d6f3ccfb20c78aaece417954ecee0537ecf4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|