Sphinx logo
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.

01

Read the Docs support

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

02

API reference indexing

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

03

Version-aware indexing

Add one source per Sphinx doc version and give each a Version label. Kelu passes the label to the model with every excerpt. On the Enterprise plan, source groups scope each version's widget to that version.

04

Widget injection via conf.py

Add the Kelu widget script to html_js_files in conf.py to surface chat to all readers.

Setup

How to set it up

  1. 1

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

  2. 2

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

  3. 3

    Add the widget script to html_js_files in conf.py to display AI chat on your docs site.

Got questions?

Sphinx — Frequently Asked Questions

Common questions about connecting Kelu to Sphinx.

Ready to connect Sphinx?

Start free. No credit card required.