An AI assistant for Sphinx documentation
Why Sphinx projects add an assistant
Sphinx builds large docs from reStructuredText or Markdown, often with an API reference from your code.
Large docs are hard to search when a user has an error, not a keyword. An assistant answers the actual question.
Answering setup and error questions
Connection steps, version pairs and error messages are the most common questions.
The assistant gives the right call and links to the page that explains it.
Help with hardware and firmware
Hardware SDKs add one more layer: firmware versions and safety rules.
The assistant answers from your release notes and safety pages and sends flight issues to your team.
Setup with html_js_files
Sphinx adds every entry in html_js_files to each HTML page it builds. The entry takes a full URL and script attributes.
Add one entry, rebuild, and the chat appears on all pages.
Learning from questions
Every chat is saved. You see which topics users ask about most.
Use that list to add examples where they help most.