sphinx-iconify¶

sphinx-iconify provides the :iconify: role, which allows you to use the <iconify-icon> web component

Documentation: https://sphinx-iconify.lepture.com/
Source Code: https://github.com/lepture/sphinx-iconify

Install¶

pip install sphinx-iconify

Then, add the extension to your conf.py:

conf.py¶

extensions = [
    # ...
    "sphinx_iconify",
]

Examples¶

Using the :iconify: role is very simple :

:iconify:`simple-icons:python`

Our Installation page is using sphinx-iconify, the source code for the “package install” part:

.. tab-set::
    :class: outline

    .. tab-item:: :iconify:`devicon:pypi` pip

        .. code-block:: shell

            pip install shibuya

    .. tab-item:: :iconify:`material-icon-theme:uv` uv

        .. code-block:: shell

            uv add --dev shibuya

pip

pip install shibuya

uv add --dev shibuya

Since shibuya theme has built-in accent colors, it is also possible to decorate the icon with a data-accent-color attribute:

:iconify:`simple-icons:python data-accent-color=indigo`

You can find all the supported colors on Accent colors.