Getting Started¶
This guide will help you install sphinx-typesense and configure your first Typesense-powered documentation search.
Prerequisites¶
Before you begin, you will need:
Python 3.9+ - sphinx-typesense requires Python 3.9 or later
Sphinx 7.0+ - A Sphinx documentation project
Typesense Server - Either:
A self-hosted Typesense server (see Typesense Installation Guide)
A Typesense Cloud account (see Typesense Cloud)
What You Will Learn¶
By the end of this guide, you will:
Have sphinx-typesense installed in your project
Understand the basic configuration options
Have a working search integration in your documentation
Time Required¶
Installation: 2 minutes
Basic Configuration: 5 minutes
First Build with Search: 5 minutes
Next Steps¶
Start with Installation to add sphinx-typesense to your project.