Metadata-Version: 2.4
Name: sphinx_biel
Version: 0.1.12
Summary: Biel.ai AI assistant for Sphinx documentation.
Author-email: TechDocs Studio <info@techdocs.studio>
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.md
Requires-Dist: Sphinx>=7,<10
Project-URL: Home, https://github.com/TechDocsStudio/sphinx-biel

AI assistant extension for Sphinx
=================================

Add the `Biel.ai <https://biel.ai>`_ AI assistant and documentation search to your Sphinx documentation. Help readers get answers grounded in your documentation, with links to the sources.

.. image:: https://docs.biel.ai/assets/images/biel-widget-docs-bd28548cf26a37bcb7c496487280bbfe.png
   :alt: Biel.ai AI assistant for Sphinx

Biel.ai's extension adds the website assistant to Sphinx sites, including sites using the Read the Docs theme. Add the search widget separately to offer documentation search.

**Note:** A Biel.ai plan is required to use this plugin. Try it free for 14 days—no credit card required.

Key features
------------

- **Ask AI** button that opens the documentation assistant for answers with source links.
- **Documentation search**: add a search widget for matching pages from indexed
  docs, with an **Ask AI** action that sends the current query to the assistant.
- Integration with Sphinx.  
- Customizable to match your site's branding and user needs.
- **Connect** menu to connect indexed docs to Claude Code, Codex, and other MCP
  clients by copying an endpoint or setup command, or opening a supported client.

Get started
-----------

See the `Sphinx AI assistant integration guide <https://docs.biel.ai/installation/sphinx>`_ for installation and setup instructions, including `selecting a widget version <https://docs.biel.ai/installation/sphinx#select-a-widget-version>`_.

The extension loads the widget's JavaScript and CSS from the CDN. It uses
``latest`` by default; set ``biel_version`` in ``conf.py`` to choose a specific
release. You do not need to install ``biel-search`` with npm.

Support
-------

Need assistance? `Contact us <https://docs.biel.ai/support>`_ for help.

License
-------

Copyright (c) 2024 Biel.ai

Licensed under the `MIT License <LICENSE>`_.

Development
-----------

For a reusable Sphinx project to test locally, see ``demo/README.rst``.
The demo is excluded from published wheels and source distributions.

Widget option metadata is included in the Python package. To refresh it, unpack
the published widget and run
``python tools/update_widget_options.py /path/to/biel-search``. This reads the
widget's property definitions without executing its JavaScript.

Build with ``python -m build --wheel``, install the wheel in a separate Sphinx
environment, and run ``python tests/test_artifact.py /tmp/biel-sphinx-site``.
This checks the generated HTML, typed settings and version overrides.

The browser test also needs Puppeteer and a local widget package for its test
fixtures. Set ``NODE_PATH`` to that test environment's ``node_modules`` and run
``PUPPETEER_EXECUTABLE_PATH=/path/to/chrome node tests/browser-contract.cjs /tmp/biel-sphinx-site``.
It uses local sample replies to check the button and assistant settings.

