Installation¶

sphinx-typesense can be installed using your preferred Python package manager.

uv add sphinx-typesense

pip

pip install sphinx-typesense

Poetry

poetry add sphinx-typesense

PDM

pdm add sphinx-typesense

Development Installation¶

To install from source for development:

git clone https://github.com/JacobCoffee/sphinx-typesense.git
cd sphinx-typesense
uv sync --group dev

sphinx-typesense has the following dependencies, which are automatically installed:

Package	Version	Purpose
sphinx	>=7.0.0	Sphinx documentation framework
typesense	>=0.21.0	Typesense Python client
beautifulsoup4	>=4.12.0	HTML parsing for content extraction

To use the Pagefind backend (static search, no server required), install with the pagefind extra:

uv add "sphinx-typesense[pagefind]"

pip

pip install "sphinx-typesense[pagefind]"

Poetry

poetry add "sphinx-typesense[pagefind]"

PDM

pdm add "sphinx-typesense[pagefind]"

This installs the Python pagefind package which bundles the Pagefind binary. No Node.js or npm is required.

For building documentation:

uv sync --group docs

This installs additional packages needed for building the sphinx-typesense documentation itself, including the Shibuya theme and sphinx-design.

After installation, verify that sphinx-typesense is available:

>>> import sphinx_typesense
>>> sphinx_typesense.__version__
'0.1.0'

Continue to Quickstart to configure sphinx-typesense in your project.