最初に

動作環境

• Python 3.7+

  • 依存パッケージについては、 pyproject.toml を参照して下さい。

• SQLite 3.34.0+

インストール

PyPI上で公開されています。

pip install sphinx-sqlite3fts

もし最新のソースを試したい場合は、GitHubからインストールできます。

pip install git+https://github.com/attakei-lab/sphinx-sqlite3fts.git

利用法

まずは、ドキュメントの conf.py に設定を追記する。

extensions = [
    "sphinx_sqlite3fts",
]

# Set if you want to use for HTML search
sqlite3fts_use_search_html = True

ローカルに生成されたデータベースから検索を試す。

You can build database by sqlite builder.

make sqlite
sqlite3 _build/sqlite/db.sqlite

sqlite> SELECT * FROM content MATCH "installation";

See データベース仕様.