Add Chat Button to Sphinx

What is Sphinx

Sphinx is a documentation platform often used for Python projects.

Get an API key

Follow these steps to create an API key for your web integration.

Load the script files

Add the below scripts to the conf.py file:

# ...
html_js_files = [
    ('https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/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

// Initialize the widget using the Inkeep.ChatButton() function.
const inkeepWidget = Inkeep.ChatButton({
  baseSettings: {
    apiKey: "INKEEP_API_KEY", // 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
    aiAssistantAvatar: "/img/logo.svg", // use your own AI assistant avatar
    exampleQuestions: [
      "Example question 1?",
      "Example question 2?",
      "Example question 3?",
    ],
  },
});

For a full list of customizations, check out the Chat Button documentation.

Add Chat Button to Sphinx

What is Sphinx

Get an API key

Load the script files

Create the addInkeep.js script

On this page