Repository files navigation

SQL backend for the Sphinx documentation generator.

A Sphinx extension to provide Full-Text-Search (FTS) based on SQLdatabases.

The package is completely based onatsphinx-sqlite3fts byKazuya Takei, so many kudos and thanks go out to him.See alsosqlite3fts on GitHub.

Please note that thesphinx-sql-backend package contains alpha-, beta- andincubation-quality code, and as such, is considered to be a work in progress.Contributions of all kinds are much welcome, in order to make it more solid,and to add features.

Breaking changes should be expected until a 1.0 release, so version pinning isstrongly recommended, especially when you use it as a library.

• Indexing: When runningsphinx-build, store documents into database.
• Searching: Provide backend service for responding to search requests andsearch-as-you-type UI based onreadthedocs-sphinx-search.

pip install git+https://github.com/panodata/sphinx-sql-backend.git

1. Register extension into yourconf.py and configure it.

extensions= [## Other extensions#"atsphinx.sqlite3fts",# Add it]

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

sphinx-build -M html source build

3. To try it in local, usehttp.server module.

 python -m http.server -d _build/htmlPlease access http://localhost:8000/search.html

Install package in development mode:

pip install --editable='.[cli,docs,test]' --prefer-binary

Start PostgreSQL server:

docker run --rm -it --publish=5432:5432 --env "POSTGRES_HOST_AUTH_METHOD=trust" postgres:16 postgres -c log_statement=all

Invoke software tests:

export POSTGRES_LOG_STATEMENT=allpytest -vvv

Invoke linters:

pip install pre-commitpre-commit run --all-files