sphinx-icon
===========

.. toctree::
   :hidden:

   quickstart
   contribute

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

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

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.

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.