sphinx-btn

.. image:: https://img.shields.io/badge/License-BSD_2--Clause-yellow.svg :target: https://github.com/sphinx-contrib/btn/blob/main/LICENSE :alt: License: BSD 2-Clause

.. image:: https://img.shields.io/pypi/v/sphinx-btn?logo=python&logoColor=white&color=blue :target: https://pypi.org/project/sphinx-btn/ :alt: PyPI

.. image:: https://img.shields.io/pypi/pyversions/sphinx-btn?logo=python&logoColor=white&color=blue :target: https://pypi.org/project/sphinx-btn/ :alt: supported Python version

.. image:: https://img.shields.io/github/actions/workflow/status/sphinx-contrib/btn/unit.yml?logo=github&logoColor=white :target: https://github.com/sphinx-contrib/btn/actions/workflows/unit.yml :alt: GitHub Workflow Status

.. image:: https://img.shields.io/codecov/c/github/sphinx-contrib/btn?logo=codecov&logoColor=white :target: https://codecov.io/gh/sphinx-contrib/btn :alt: Codecov

.. image:: https://img.shields.io/readthedocs/sphinx-btn?logo=readthedocs&logoColor=white :target: https://sphinx-btn.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-btn is a Sphinx extention to allow developers to use the :code:btn role to display inlined btn in their documentation. A btn is composed of an icon and/or some text. The extention currently supports only Fontawsome 6.3.0 icons.

.. code-block:: rst

I'm a :btn:`<fa-solid fa-folder> fa-folder` btn.
I'm a :btn:`<fa-solid fa-folder>` btn.
I'm a :btn:`fa-folder` btn.

.. image:: https://raw.githubusercontent.com/sphinx-contrib/btn/main/docs/_static/demo.png :alt: demo result

Please go to our doc <https://sphinx-btn.readthedocs.io/en/latest/>__ 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 <https://github.com/sphinx-contrib/btn/blob/main/CONTRIBUTING.rst>. Meet our contributor <https://github.com/sphinx-contrib/btn/blob/main/AUTHORS.rst>.