sphinx_biel 0.1.1__py2.py3-none-any.whl → 0.1.3__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sphinx_biel/__init__.py +17 -2
- sphinx_biel-0.1.3.dist-info/METADATA +46 -0
- sphinx_biel-0.1.3.dist-info/RECORD +5 -0
- {sphinx_biel-0.1.1.dist-info → sphinx_biel-0.1.3.dist-info}/WHEEL +1 -1
- sphinx_biel-0.1.1.dist-info/METADATA +0 -56
- sphinx_biel-0.1.1.dist-info/RECORD +0 -5
- {sphinx_biel-0.1.1.dist-info → sphinx_biel-0.1.3.dist-info/licenses}/LICENSE.md +0 -0
sphinx_biel/__init__.py
CHANGED
@@ -5,7 +5,7 @@ ASK AI chatbot for Sphinx.
|
|
5
5
|
This code is licensed under MIT license (see LICENSE.md for details).
|
6
6
|
"""
|
7
7
|
|
8
|
-
__version__ = "0.1.
|
8
|
+
__version__ = "0.1.3"
|
9
9
|
|
10
10
|
from sphinx.application import Sphinx
|
11
11
|
|
@@ -27,7 +27,17 @@ class BielExtension:
|
|
27
27
|
'hide_feedback': None,
|
28
28
|
'initial_messages': None,
|
29
29
|
'modal_position': None,
|
30
|
-
'version': 'latest'
|
30
|
+
'version': 'latest',
|
31
|
+
'custom_font': None,
|
32
|
+
'email': None,
|
33
|
+
'hide_icon': None,
|
34
|
+
'input_placeholder_text': None,
|
35
|
+
'send_button_text': None,
|
36
|
+
'suggested_questions_title': None,
|
37
|
+
'show_terms_modal': None,
|
38
|
+
'terms_title': None,
|
39
|
+
'terms_description': None,
|
40
|
+
'terms_checkbox_text': None
|
31
41
|
}
|
32
42
|
|
33
43
|
def __init__(self, app: Sphinx):
|
@@ -83,3 +93,8 @@ class BielExtension:
|
|
83
93
|
|
84
94
|
def setup(app: Sphinx):
|
85
95
|
extension = BielExtension(app)
|
96
|
+
return {
|
97
|
+
'version': __version__,
|
98
|
+
'parallel_read_safe': True,
|
99
|
+
'parallel_write_safe': True,
|
100
|
+
}
|
@@ -0,0 +1,46 @@
|
|
1
|
+
Metadata-Version: 2.4
|
2
|
+
Name: sphinx_biel
|
3
|
+
Version: 0.1.3
|
4
|
+
Summary: ASK AI chatbot for Sphinx.
|
5
|
+
Author-email: TechDocs Studio <hi@techdocs.studio>
|
6
|
+
Description-Content-Type: text/x-rst
|
7
|
+
License-File: LICENSE.md
|
8
|
+
Project-URL: Home, https://github.com/TechDocsStudio/sphinx-biel
|
9
|
+
|
10
|
+
AI chatbot extension for Sphinx
|
11
|
+
===============================
|
12
|
+
|
13
|
+
Ask AI chatbot plugin for Sphinx sites, powered by `Biel.ai <https://biel.ai>`_.
|
14
|
+
|
15
|
+
.. image:: https://biel.ai/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Fcarousel-02.d9a9a331.png&w=1200&q=75
|
16
|
+
:alt: AI chatbot Sphinx
|
17
|
+
|
18
|
+
Add an AI chatbot to your Sphinx documentation using Biel.ai's extension. The integration works with any Sphinx theme, including Read the Docs, and adds both chat and search capabilities.
|
19
|
+
|
20
|
+
**Note:** A Biel.ai plan is required to use this plugin. Try it free for 14 days—no credit card required.
|
21
|
+
|
22
|
+
Key features
|
23
|
+
------------
|
24
|
+
|
25
|
+
- AI chatbot that provides instant responses to documentation queries.
|
26
|
+
- AI search engine for quick and relevant information retrieval.
|
27
|
+
- Integration with Sphinx.
|
28
|
+
- Customizable to match your site's branding and user needs.
|
29
|
+
|
30
|
+
Get started
|
31
|
+
-----------
|
32
|
+
|
33
|
+
See the `Sphinx AI chatbot integration guide <https://docs.biel.ai/installation/sphinx>`_ for installation and setup instructions.
|
34
|
+
|
35
|
+
Support
|
36
|
+
-------
|
37
|
+
|
38
|
+
Need assistance? `Contact us <https://docs.biel.ai/support>`_ for help.
|
39
|
+
|
40
|
+
License
|
41
|
+
-------
|
42
|
+
|
43
|
+
Copyright (c) 2024 Biel.ai
|
44
|
+
|
45
|
+
Licensed under the `MIT License <LICENSE>`_.
|
46
|
+
|
@@ -0,0 +1,5 @@
|
|
1
|
+
sphinx_biel/__init__.py,sha256=5w7YDg4PhtcVpF0nDkJWKudWyGc7iKvmjPrAr4Hd1-c,3570
|
2
|
+
sphinx_biel-0.1.3.dist-info/licenses/LICENSE.md,sha256=Iswh4l-k6fOZeKmtFbDd_bJjuVOgNJcKJZ7uAVZrUv8,1051
|
3
|
+
sphinx_biel-0.1.3.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
|
4
|
+
sphinx_biel-0.1.3.dist-info/METADATA,sha256=dZqTDWo6CZxXW9DaqsyTO83fiaQmUJScp9rcPdNX2ys,1449
|
5
|
+
sphinx_biel-0.1.3.dist-info/RECORD,,
|
@@ -1,56 +0,0 @@
|
|
1
|
-
Metadata-Version: 2.1
|
2
|
-
Name: sphinx_biel
|
3
|
-
Version: 0.1.1
|
4
|
-
Summary: ASK AI chatbot for Sphinx.
|
5
|
-
Author-email: TechDocs Studio <hi@techdocs.studio>
|
6
|
-
Description-Content-Type: text/x-rst
|
7
|
-
Project-URL: Home, https://github.com/TechDocsStudio/sphinx-biel
|
8
|
-
|
9
|
-
biel-pushfeedback
|
10
|
-
=================
|
11
|
-
|
12
|
-
ASK AI chatbot for Sphinx documentation sites.
|
13
|
-
|
14
|
-
Installation
|
15
|
-
------------
|
16
|
-
|
17
|
-
#. Create a `Biel.ai account <https://biel.ai/>`_.
|
18
|
-
|
19
|
-
#. Install ``sphinx-biel`` using PIP.
|
20
|
-
|
21
|
-
.. code-block:: bash
|
22
|
-
|
23
|
-
pip install sphinx-biel
|
24
|
-
|
25
|
-
#. Add the extension to your Sphinx project ``conf.py`` file.
|
26
|
-
|
27
|
-
.. code-block:: python
|
28
|
-
|
29
|
-
extensions = ['sphinx_biel']
|
30
|
-
|
31
|
-
#. Configure your project ID in the ``conf.py`` file:
|
32
|
-
|
33
|
-
.. code-block:: python
|
34
|
-
|
35
|
-
biel_project = '<YOUR_PROJECT_ID>'
|
36
|
-
biel_button_text = 'Ask AI'
|
37
|
-
biel_header_title = 'Biel AI Chatbot'
|
38
|
-
|
39
|
-
Replace ``<YOUR_PROJECT_ID>`` with your project's ID from the `Biel.ai dashboard <https://docs.biel.ai/#2-create-a-project>`_.
|
40
|
-
|
41
|
-
#. Build the documentation:
|
42
|
-
|
43
|
-
.. code-block:: bash
|
44
|
-
|
45
|
-
make html
|
46
|
-
|
47
|
-
Once built, open your documentation in a web browser. Verify that the chatbot appears and works correctly on your site.
|
48
|
-
|
49
|
-
For advanced configuration options, see `Sphinx Biel documentation <https://docs.biel.ai/installation/sphinx>`_.
|
50
|
-
|
51
|
-
License
|
52
|
-
-------
|
53
|
-
|
54
|
-
Copyright (c) 2024 Biel.ai
|
55
|
-
Licensed under the `MIT License <https://github.com/TechDocsStudio/sphinx-biel/blob/main/LICENSE.md>`_.
|
56
|
-
|
@@ -1,5 +0,0 @@
|
|
1
|
-
sphinx_biel/__init__.py,sha256=4CH9laVF-21idQE1Gs0dWKD6bqKueiVIchkdVGsmKR0,3115
|
2
|
-
sphinx_biel-0.1.1.dist-info/LICENSE.md,sha256=Iswh4l-k6fOZeKmtFbDd_bJjuVOgNJcKJZ7uAVZrUv8,1051
|
3
|
-
sphinx_biel-0.1.1.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
|
4
|
-
sphinx_biel-0.1.1.dist-info/METADATA,sha256=vcd-xr0PSlfqyUyJVxoXcKFPuMZycBSzFPxRSKwRIew,1418
|
5
|
-
sphinx_biel-0.1.1.dist-info/RECORD,,
|
File without changes
|