Sphinx
Chat Button
Add AI chat to your Sphinx documentation.
What is Sphinx
Sphinx is a documentation platform often used for Python projects.
Load the script files
Add the below scripts to the conf.py
file:
# ...
html_js_files = [
('https://unpkg.com/@inkeep/widgets-embed@0.2.278/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: "ICON_TEXT",
baseSettings: {
apiKey: "YOUR_API_KEY",
integrationId: "YOUR_INTEGRATION_ID",
organizationId: "YOUR_ORGANIZATION_ID",
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.