Add Search Bar 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, create a container and configure the search bar component.

Configure the component

addInkeep.js

// Embed the widget using the `Inkeep.SearchBar()` function.
const inkeepWidget = Inkeep.SearchBar("#inkeepSearchBar", {
  baseSettings: {
    apiKey: "INKEEP_API_KEY", // required
    primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
    organizationDisplayName: "Inkeep",
    // ...optional settings
    theme: {
      // optional path to a custom stylesheet
      styles: [
        {
          key: "main",
          type: "link",
          value: "/path/to/stylesheets",
        },
      ],
      // 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?",
    ],
  },
});

Container element

Create a searchbox.html file in source/_templates and paste in the below::

Note

This Inkeep SearchBar widget will replace the default search bar used on the website.

searchbox.html

<div id="inkeepSearchBar"></div>

For a full list of customizations, check out the Search Bar documentation.