Metadata-Version: 2.3
Name: atsphinx-htmx-boost
Version: 0.2.0
Summary: [EXPERIMENTAL] Improve user-experience for Sphinx document.
Project-URL: Home, https://github.com/atsphinx/htmx-boost
Project-URL: Repository, https://github.com/atsphinx/htmx-boost
Project-URL: Issues, https://github.com/atsphinx/htmx-boost/issues
Project-URL: Changelog, https://github.com/atsphinx/htmx-boost/blob/main/CHANGES.rst
Author-email: Kazuya Takei <myself@attakei.net>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: reStructuredText
Requires-Python: >=3.8
Requires-Dist: atsphinx-helper
Requires-Dist: beautifulsoup4
Requires-Dist: sphinx
Description-Content-Type: text/x-rst

===================
atsphinx-htmx-boost
===================

.. note:: This is experimental extension.

Improvement user experience of your documents using htmx.

Usage
=====

Installation
------------

Install into your environment.

.. code:: console

   pip install atsphinx-htmx-boost

Configuration
-------------

Add it as extension into your ``conf.py``. There are not other settings.

.. code:: python

   extensions = [
       "atsphinx.htmx_boost",
   ]
