sphinx-btn
===========

.. toctree::
   :hidden:

   quickstart
   contribute

The btn extension allows you to embed fontawesome 6.3.0 icons in guilabels as inline roles in a sphinx documentation.

.. 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.

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.

Documentation contents
----------------------

The documentation contains 2 sections:

.. grid:: 1 2 2 2

   .. grid-item::

      .. card:: Quickstart
         :link: quickstart.html

         Lib instalation and usage of the video directive

   .. grid-item::

      .. card:: Contribute
         :link: contribute.html

         Help us improve the Sphinx extention.