Metadata-Version: 2.1
Name: sphinx-sqlite3fts
Version: 0.1.0
Summary: Sphinx document searcher using SQLite3.
Author-email: Kazuya Takei <myself@attakei.net>
Description-Content-Type: text/x-rst
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Dist: docutils
Requires-Dist: peewee
Requires-Dist: Sphinx
Requires-Dist: Click ; extra == "cli"
Requires-Dist: furo ; extra == "docs"
Requires-Dist: sphinx-intl ; extra == "docs"
Requires-Dist: pytest ; extra == "test"
Project-URL: Documentation, https://sphinx-sqlite3fts.readthedocs.io/
Project-URL: Home, https://attakei-lab.github.io/sphinx-sqlite3fts
Project-URL: Repository, https://github.com/attakei-lab/sphinx-sqlite3fts
Provides-Extra: cli
Provides-Extra: docs
Provides-Extra: test

=================
sphinx-sqlite3fts
=================

Sphinx new search page using SQL.js and SQLite database included FTS extension.

.. image:: https://img.shields.io/pypi/v/sphinx-sqlite3fts.svg
    :target: https://pypi.org/project/sphinx-sqlite3fts/

.. image:: https://github.com/attakei-lab/sphinx-sqlite3fts/actions/workflows/main.yml/badge.svg?branch=main
   :alt: Run CI
   :target: https://github.com/attakei-lab/sphinx-sqlite3fts/actions/workflows/main.yml

.. image:: https://readthedocs.org/projects/sphinx-sqlite3fts/badge/?version=latest
    :target: https://sphinx-sqlite3fts.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. note:: This is experimental library

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.

.. code-block:: console

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

Usage
=====

1. Register extension into your ``conf.py`` and configure it.

.. code-block:: python

   extensions = [
       #
       # Other extensions
       #
       "sphinx_sqlite3fts",  # Add it
   ]

2. Run builder (html-based builder only).

.. code-block:: console

   sphinx-build -M html source build

3. To try it in local, use ``http.server`` module.

.. code-block:: console

   python -m http.server -d build

  Please access http://localhost:8000/search.html

