Sphinx
Add AI Chat to your Sphinx docs
What is Sphinx
Sphinx is a documentation platform often used for Python projects.
Get an API key
- Go to the Inkeep Dashboard
- Select your project under Projects
- Go to the Integrations tab
- Click on Create integration
- Select Web
- Provide a Name and URL (optional) for the integration
- Click on Create
- Click the Example < /> button to get your API key and view suggested settings
Load the script files
Add the below scripts to the conf.py
file:
# ...
html_js_files = [
('https://unpkg.com/@inkeep/uikit-js@0.3.8/dist/embed.js', {'defer': 'defer', 'type': 'module'}),
('js/addInkeep.js', {'defer': 'defer', 'type': 'module'}),
]
Create the addInkeep.js script
Create an addInkeep.js
file in your _static
folder.
touch _static/js/addInkeep.js
Now, configure the chat button component.
addInkeep.js
// Embed the widget using the `Inkeep.embed()` function.
const inkeepWidget = Inkeep().embed({
componentType: "ChatButton",
properties: {
chatButtonType: "PILL",
baseSettings: {
apiKey: "INKEEP_API_KEY", // required
integrationId: "INKEEP_INTEGRATION_ID", // required
organizationId: "INKEEP_ORGANIZATION_ID", // required
primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
organizationDisplayName: "Inkeep",
// ...optional settings
},
modalSettings: {
// optional settings
},
searchSettings: {
// optional settings
},
aiChatSettings: {
// optional settings
botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
quickQuestions: [
"Example question 1?",
"Example question 2?",
"Example question 3?",
],
},
},
});
For a full list of customizations, check out the Chat Button documentation.