Metadata-Version: 2.4
Name: sphinx-iconify
Version: 0.1.0
Summary: A sphinx role for icons, powered by iconify.
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
