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@<<version>>/dist/embed.js', {'defer': 'defer', 'type': 'module'}),
    ('js/addInkeep.js', {'defer': 'defer', 'type': 'module'}),
]

Latest widget version is 0.2.258

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.embed()` function.
const inkeepWidget = Inkeep().embed({
  componentType: "SearchBar",
  targetElement: document.getElementById("inkeepSearchBar"),
  properties: {
    stylesheetUrls: ['/path/to/stylesheets'], // optional
    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?",
      ],
    },
  },
});

Container element

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

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.

FAQ