https://github.com/lepture/sphinx-iconify

A sphinx extension to use `<iconify-icon>` web component.
https://github.com/lepture/sphinx-iconify

sphinx sphinx-doc sphinx-extension

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/lepture/sphinx-iconify
• Owner: lepture
• License: bsd-3-clause
• Created: 2025-07-14T06:58:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-12-18T05:18:32.000Z (7 months ago)
• Last Synced: 2026-01-07T18:17:55.223Z (7 months ago)
• Topics: sphinx, sphinx-doc, sphinx-extension
• Language: Python
• Homepage: https://sphinx-iconify.lepture.com/
• Size: 89.8 KB
• Stars: 4
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# sphinx-iconify

A sphinx extension to use ```` 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