Metadata-Version: 2.4
Name: atsphinx-pagefind
Version: 0.1.0
Summary: Pagefind search component for Sphinx.
Project-URL: Home, https://github.com/atsphinx/pagefind
Project-URL: Documentation, https://atsphinx.github.io/pagefind
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: reStructuredText
Requires-Python: >=3.9
Requires-Dist: pagefind[bin]>=1.3.0
Requires-Dist: sphinx
Description-Content-Type: text/x-rst

=================
atsphinx-pagefind
=================

Pagefind search component for Sphinx.

Overview
========

This is Sphinx extension to use Pagefind for searching documentation.

Pagefind is website search library for static site.It can indexes from published website.
Please see `official website <https://pagefind.app/>`_ if you want to know more information.

You can see `own document <https://atsphinx.github.io/pagefind/>`_ to know behavior of thi.

Getting started
===============

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

This publishes on PyPI. You can install by ``pip`` and other package managers.

.. code:: console

   pip install atsphinx-pagefind

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

Register this into your ``conf.py`` of document.

.. code:: python

   extensions = [
       ...,  # Your extensions
       "atsphinx.pagefind",
   ]
