Metadata-Version: 2.4
Name: sphinx-iconify
Version: 0.2.1
Summary: A sphinx role allowing you to embed icons from over 200,000 open-source vector icons.
Author-email: Hsiaoming Yang <me@lepture.com>
Project-URL: Source, https://github.com/lepture/sphinx-iconify
Project-URL: Documentation, https://sphinx-iconify.lepture.com/
Project-URL: Sponsors, https://github.com/sponsors/lepture
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
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: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx
Dynamic: license-file

# sphinx-iconify

A sphinx extension to use ``<iconify-icon>`` web component.

## Install

```
pip install sphinx-iconify
```

## Usage

Add extension into ``docs/conf.py``:

```python
extensions = [
    "sphinx_iconify",
]
```

Use the role in your documentation:

```
This is a GitHub icon :iconify:`simple-icons:github`
```

## License

BSD
