sphinx_biel 0.1.0

ASK AI chatbot for Sphinx.

ASK AI chatbot for Sphinx documentation sites.

Installation

1. Create a Biel.ai account.

2. Install sphinx-biel using PIP.

   pip install sphinx-biel

3. Add the extension to your Sphinx project conf.py file.

   extensions = ['sphinx_biel']

4. Configure your project ID in the conf.py file:

   biel_project = '<YOUR_PROJECT_ID>'
   biel_button_text = 'Ask AI'
   biel_header_title = 'Biel AI Chatbot'

   Replace <YOUR_PROJECT_ID> with your project’s ID from the Biel.ai dashboard.

5. Build the documentation:

   make html

   Once built, open your documentation in a web browser. Verify that the chatbot appears and works correctly on your site.

For advanced configuration options, see Sphinx Biel documentation.

License

Copyright (c) 2024 Biel.ai Licensed under the MIT License.