ASK AI chatbot for Sphinx documentation sites.
Installation
Create a Biel.ai account.
Install sphinx-biel using PIP.
pip install sphinx-bielAdd the extension to your Sphinx project conf.py file.
extensions = ['sphinx_biel']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.
Build the documentation:
make htmlOnce 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.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_biel-0.1.1.tar.gz | 4.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_biel-0.1.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 7.7 kB
Release files / sphinx_biel-0.1.1.tar.gz
| Download URL | sphinx_biel-0.1.1.tar.gz |
|---|---|
| Size | 4.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c6fff29bb5942891e30364225feb25a8436e5cfd1965ad8d973cc34d2b06d346
|
|
BLAKE2b-256 checksum How to use checksums |
567dc21755cca49182ec8d7cb90c538b788843db7c6deb5493fa4da85eaf043d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.3
|
Release files / sphinx_biel-0.1.1-py2.py3-none-any.whl
| Download URL | sphinx_biel-0.1.1-py2.py3-none-any.whl |
|---|---|
| Size | 3.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c7432407affc0d7717e080cc18b7a4ddd44416fe4d4a9959a972064ee2eaa815
|
|
BLAKE2b-256 checksum How to use checksums |
db86f63fd4d0cbf9c3b34ed3efee958e6541e374919dcfa2dd8e164b19831acd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.3
|