sphinx_biel 0.1.0__py2.py3-none-any.whl

sphinx_biel/__init__.py

@@ -0,0 +1,84 @@
+"""
+ASK AI chatbot for Sphinx.
+
+(c) 2024 - present Biel.ai
+This code is licensed under MIT license (see LICENSE.md for details).
+"""
+
+__version__ = "0.1.0"
+
+from sphinx.application import Sphinx
+
+class BielExtension:
+    DEFAULT_OPTIONS = {
+        'button_text': 'Ask AI',
+        'header_title': 'Biel.ai chatbot',
+        'button_style': "dark",
+        'button_position': 'bottom-right',
+        'disable_input': None,
+        'error_message_default': None,
+        'error_message_4_0_3': None,
+        'error_message_4_0_4': None,
+        'expand_modal': None,
+        'footer_text': None,
+        'header_title': None,
+        'hide_expand_button': None,
+        'hide_feedback': None,
+        'initial_messages': None,
+        'modal_position': None,
+        'version': 'latest'
+    }
+
+    def __init__(self, app: Sphinx):
+        self.app = app
+        self.setup_options()
+        self.setup_events()
+
+    @staticmethod
+    def snake_to_kebab(string):
+        """Convert snake_case string to kebab-case."""
+        return string.replace('_', '-')
+
+    def inject_biel_scripts(self, app, pagename, templatename, context, doctree):
+        version = getattr(app.config, "biel_version", self.DEFAULT_OPTIONS['version'])
+        biel_js_module = f'''
+            <script type="module" src="https://cdn.jsdelivr.net/npm/biel-search@{version}/dist/biel-search/biel-search.esm.js"></script>
+        '''
+
+        # Add Biel JS module to body
+        context.setdefault('body', '')
+        context['body'] += biel_js_module
+
+        if getattr(app.config, "biel_button_position", None) != "default":
+            attribute_pairs = [
+                f'bielBtn.setAttribute("{self.snake_to_kebab(key)}", "{getattr(app.config, f"biel_{key}")}");'
+                for key in self.DEFAULT_OPTIONS.keys() if getattr(app.config, f"biel_{key}") is not None
+            ]
+            set_attributes_script = "\n                    ".join(attribute_pairs)
+            
+            button_text = getattr(app.config, "biel_button_text", self.DEFAULT_OPTIONS['button_text'])
+
+            biel_script = f'''
+                <script>
+                    window.addEventListener('DOMContentLoaded', (event) => {{
+                        let bielBtn = document.createElement("biel-button");
+                        bielBtn.innerHTML = "{button_text}";
+                        {set_attributes_script}
+                        document.body.appendChild(bielBtn);
+                    }});
+                </script>
+            '''
+            context['body'] += biel_script
+
+    def setup_options(self):
+        for key in self.DEFAULT_OPTIONS.keys():
+            self.app.add_config_value(f'biel_{key}', self.DEFAULT_OPTIONS[key], 'html')
+
+    def setup_events(self):
+        version = getattr(self.app.config, "biel_version", self.DEFAULT_OPTIONS["version"])
+        self.app.add_css_file(f'https://cdn.jsdelivr.net/npm/biel-search@{version}/dist/biel-search/biel-search.css')
+        self.app.connect('html-page-context', self.inject_biel_scripts)
+
+
+def setup(app: Sphinx):
+    extension = BielExtension(app)

sphinx_biel-0.1.0.dist-info/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Biel.ai
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sphinx_biel-0.1.0.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.1
+Name: sphinx_biel
+Version: 0.1.0
+Summary: ASK AI chatbot for Sphinx.
+Author-email: TechDocs Studio <hi@techdocs.studio>
+Description-Content-Type: text/x-rst
+Project-URL: Home, https://github.com/TechDocsStudio/sphinx-biel
+
+biel-pushfeedback
+=================
+
+ASK AI chatbot for Sphinx documentation sites.
+
+Installation
+------------
+
+#. Create a `Biel.ai account <https://biel.ai/>`_.
+
+#. Install ``sphinx-biel`` using PIP.
+
+   .. code-block:: bash
+
+      pip install sphinx-biel
+
+#. Add the extension to your Sphinx project ``conf.py`` file.
+
+   .. code-block:: python
+
+      extensions = ['sphinx_biel']
+
+#. Configure your project ID in the ``conf.py`` file:
+
+   .. code-block:: python
+
+     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 <https://docs.biel.ai/#2-create-a-project>`_.
+
+#. Build the documentation:
+
+   .. code-block:: bash
+
+      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 <https://docs.biel.ai/installation/sphinx>`_.
+
+License
+-------
+
+Copyright (c) 2024 Biel.ai
+Licensed under the `MIT License <https://github.com/TechDocsStudio/sphinx-biel/blob/main/LICENSE.md>`_.
+

sphinx_biel-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+sphinx_biel/__init__.py,sha256=i0IDFLtzhpb6YaKU1Pv0z6ffIPVZf0NOEtjqM3tjFlk,3090
+sphinx_biel-0.1.0.dist-info/LICENSE.md,sha256=Iswh4l-k6fOZeKmtFbDd_bJjuVOgNJcKJZ7uAVZrUv8,1051
+sphinx_biel-0.1.0.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
+sphinx_biel-0.1.0.dist-info/METADATA,sha256=Q5_VGFPHNn2fBT4gUb5FZq5nVXBqlAmiCEXtUvjkYU0,1418
+sphinx_biel-0.1.0.dist-info/RECORD,,

sphinx_biel-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: flit 3.9.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any