Skip to main content

ASK AI chatbot for Sphinx.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_biel-0.1.2.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

sphinx_biel-0.1.2-py2.py3-none-any.whl (3.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinx_biel-0.1.2.tar.gz.

File metadata

  • Download URL: sphinx_biel-0.1.2.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for sphinx_biel-0.1.2.tar.gz
Algorithm Hash digest
SHA256 df8aaf3c3b22c2da965f0c9cd1c16c92230367ff546477e36fa091ab4bc31c38
MD5 e687e232b393b0532a46bd8fd3d452aa
BLAKE2b-256 8a8c50cda672a2f35063f13a60dc29750a777e68c13d5cd390baad42ed6cff47

See more details on using hashes here.

File details

Details for the file sphinx_biel-0.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_biel-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 895b21616c51379cfbff6f07efcfa535399776499ceacf3bc844035bbad48a80
MD5 73a5fe6dd6fae422a9bab5ff4a431305
BLAKE2b-256 7b3131468c412599cd55b5635afd5cf26f99e12d802807d569d6a3037671abab

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page