https://github.com/sphinx-contrib/icon
custom sphinx role to embed inline icons
https://github.com/sphinx-contrib/icon
extention fontawesome python sphinx
Last synced: 7 days ago
JSON representation
custom sphinx role to embed inline icons
- Host: GitHub
- URL: https://github.com/sphinx-contrib/icon
- Owner: sphinx-contrib
- License: bsd-2-clause
- Created: 2022-01-18T09:33:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T06:55:41.000Z (8 months ago)
- Last Synced: 2025-04-19T04:45:37.764Z (21 days ago)
- Topics: extention, fontawesome, python, sphinx
- Language: Python
- Homepage:
- Size: 115 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.rst
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
sphinx-icon
===========
.. image:: https://img.shields.io/badge/License-BSD_2--Clause-yellow.svg
:target: https://github.com/sphinx-contrib/icon/blob/main/LICENSE
:alt: License: BSD 2-Clause
.. image:: https://img.shields.io/pypi/v/sphinx-icon?logo=python&logoColor=white&color=blue
:target: https://pypi.org/project/sphinx-icon/
:alt: PyPI
.. image:: https://img.shields.io/pypi/pyversions/sphinx-icon?logo=python&logoColor=white&color=blue
:target: https://pypi.org/project/sphinx-icon/
:alt: supported Python version
.. image:: https://img.shields.io/github/actions/workflow/status/sphinx-contrib/icon/unit.yaml?logo=github&logoColor=white
:target: https://github.com/sphinx-contrib/icon/actions/workflows/unit.yaml
:alt: GitHub Workflow Status
.. image:: https://img.shields.io/codecov/c/github/sphinx-contrib/icon?logo=codecov&logoColor=white
:target: https://codecov.io/gh/sphinx-contrib/icon
:alt: Codecov
.. image:: https://img.shields.io/readthedocs/sphinx-icon?logo=readthedocs&logoColor=white
:target: https://sphinx-icon.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black badge
.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
:target: https://conventionalcommits.org
:alt: conventional commit
Overview
--------
:code:`sphinx-icon` is a Sphinx extention to allow developers to use the :code:`icon` role to display inlined icons.
The extention currently supports only Fontawsome 6.3.0 icons.
.. code-block:: rst
I'm an :icon:`fa-solid fa-folder` icon.
I'm an :icon:`fa-regular fa-user` icon.
I'm an :icon:`fa-brands fa-500px` icon.
.. image:: https://raw.githubusercontent.com/sphinx-contrib/icon/main/docs/_static/demo.png
:alt: demo result
Please go to our `doc `__ if you want to know more.
Contribute
----------
If you want to contribute you can fork the project in you own repository and then use it.
If you consider working with us, please follow the `contributing guidelines `__.
Meet our `contributor `__.