Sphinx
Index Sphinx-generated docs and answer developer 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.
How BeforeQuery works with Sphinx
Everything you can do once the integration is connected.
Read the Docs support
BeforeQuery 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 BeforeQuery. Users always get answers from the version that matches their usage.
Widget injection via template
Add the BeforeQuery widget script to your Sphinx HTML theme's layout.html template to surface chat to all readers.
How to set it up
Add your Sphinx documentation site URL to a BeforeQuery project. BeforeQuery discovers all pages via sitemap.xml.
Run the initial crawl. For large API references, the first index may take a few minutes.
Inject the widget script into your Sphinx theme's HTML template to display AI chat on your docs site.
Related integrations
BeforeQuery crawls your Mintlify docs site, keeps it in sync, and answers user questions with citations.
Crawl, sync, and embed AI chat on any Docusaurus v2 or v3 documentation site.
Index your GitBook spaces and let users ask questions with full citations back to source pages.
Ready to connect Sphinx?
Start free. No credit card required. Connect your first integration in under 5 minutes.