Documentation Platforms

Sphinx

Index Sphinx-generated docs and answer technical questions

What is Sphinx?

Sphinx is the standard documentation generator for Python projects and is used across many languages for technical reference documentation. It produces HTML from reStructuredText and Markdown, often hosted on Read the Docs.

Integration

How Kelu works with Sphinx

Everything you can do once the integration is connected.

Read the Docs support

Kelu crawls Sphinx docs hosted on Read the Docs, readthedocs.io, or self-hosted instances — sitemap discovery works for all.

API reference indexing

Sphinx-generated API references (autodoc output) are crawled and indexed, so users can ask questions about specific classes, methods, and modules.

Version-aware indexing

Index specific Sphinx doc versions and tag them in Kelu. Users always get answers from the version that matches their usage.

Widget injection via template

Add the Kelu widget script to your Sphinx HTML theme's layout.html template to surface chat to all readers.

Setup

How to set it up

1

Add your Sphinx documentation site URL to a Kelu knowledge base. Kelu discovers all pages via sitemap.xml.

2

Run the initial crawl. For large API references, the first index may take a few minutes.

3

Inject the widget script into your Sphinx theme's HTML template to display AI chat on your docs site.

Related integrations

Mintlify

Kelu crawls your Mintlify docs site, keeps it in sync, and answers user questions with citations.

View details

Docusaurus

Crawl, sync, and embed AI chat on any Docusaurus v2 or v3 documentation site.

View details

GitBook

Index your GitBook spaces and let users ask questions with full citations back to source pages.

View details

Sphinx — Frequently Asked Questions

Common questions about connecting Kelu to Sphinx.

Yes. Kelu crawls Sphinx documentation hosted on readthedocs.io and on Read the Docs custom domains. Sitemap discovery works for all Read the Docs deployments, including projects using the Read the Docs Sphinx theme or custom themes.

Yes. Sphinx autodoc output is rendered as standard HTML pages. Kelu crawls and indexes these pages, so users can ask questions about specific Python classes, methods, and module-level functions and receive cited answers from the API reference.

Add the Kelu widget script tag to your Sphinx HTML theme's layout.html template (or the equivalent base template for your theme). The widget will appear across all pages of your Sphinx documentation site.

Yes. You can create separate Kelu sources for each Sphinx doc version and tag them (v1.x, v2.x, latest). This allows Kelu to return answers from the correct version based on user context or widget configuration.

For large API references with hundreds of pages, the first index typically completes within a few minutes. Subsequent incremental syncs are faster because Kelu only re-processes pages whose content has changed since the previous crawl.

Ready to connect Sphinx?

Start free. No credit card required. Connect your first integration in under 5 minutes.

Get started free