Getting started#
Requirements#
Python 3.7+
You can see requirement packages from
pyproject.toml.
SQLite 3.34.0+
Installation#
This is published on PyPI.
pip install atsphinx-sqlite3fts
If you want to try latest source, install from GitHub.
pip install git+https://github.com/atsphinx/sqlite3fts.git
Usage#
At first, configuration on conf.py of your documentation.
extensions = [
"atsphinx.sqlite3fts",
]
# Set if you want to use for HTML search
sqlite3fts_use_search_html = True
Try search by local database#
You can build database by sqlite builder.
make sqlite
sqlite3 _build/sqlite/db.sqlite
sqlite> SELECT * FROM content MATCH "installation";