Skip to main content

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.

Metadata

Release files for sphinx-biel 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-biel 0.1.2
File Size Uploaded
sphinx_biel-0.1.2.tar.gz 4.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-biel 0.1.2
File Interpreter ABI Platform
sphinx_biel-0.1.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 7.8 kB

Release files / sphinx_biel-0.1.2.tar.gz

Download URL sphinx_biel-0.1.2.tar.gz
Size 4.2 kB
Tags Source
SHA-256 checksum
How to use checksums
df8aaf3c3b22c2da965f0c9cd1c16c92230367ff546477e36fa091ab4bc31c38
BLAKE2b-256 checksum
How to use checksums
8a8c50cda672a2f35063f13a60dc29750a777e68c13d5cd390baad42ed6cff47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3

Release files / sphinx_biel-0.1.2-py2.py3-none-any.whl

Download URL sphinx_biel-0.1.2-py2.py3-none-any.whl
Size 3.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
895b21616c51379cfbff6f07efcfa535399776499ceacf3bc844035bbad48a80
BLAKE2b-256 checksum
How to use checksums
7b3131468c412599cd55b5635afd5cf26f99e12d802807d569d6a3037671abab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3

Release history Release notifications | RSS feed

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page