Metadata-Version: 2.1
Name: sphinx_fasvg
Version: 2.0.2
Summary: A Sphinx fontawesome wrapper for SVG format
Keywords: sphinx,doc,theme
Author: kujiu, ptitgnu
Author-email: Nerv Project ASBL <contact@nerv-project.eu>
Maintainer: kujiu, ptitgnu
Maintainer-email: Nerv Project ASBL <contact@nerv-project.eu>
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: Sphinx>=7.0.0
Requires-Dist: Sphinx ; extra == "setup"
Requires-Dist: pytest-runner ; extra == "setup"
Requires-Dist: flake8 ; extra == "setup"
Requires-Dist: pylint ; extra == "setup"
Requires-Dist: babel ; extra == "setup"
Requires-Dist: flit ; extra == "setup"
Requires-Dist: pytest ; extra == "tests"
Requires-Dist: flake8 ; extra == "tests"
Requires-Dist: pylint ; extra == "tests"
Requires-Dist: pytest-cov ; extra == "tests"
Project-URL: changelog, https://procrastinator.nerv-project.eu/nerv-project/sphinx_fasvg/raw/branch/main/CHANGES.rst
Project-URL: editor, https://www.nerv-project.eu
Project-URL: homepage, https://www.nerv-project.eu
Project-URL: issues, https://procrastinator.nerv-project.eu/nerv-project/sphinx_fasvg/issues
Project-URL: repository, https://procrastinator.nerv-project.eu/nerv-project/sphinx_fasvg
Provides-Extra: setup
Provides-Extra: tests

Fontawesome SVG for Sphinx
==========================

Install the module :

.. code:: bash

   python setup.py install

Download SVGs from fontawesome website. Configure it
in your `conf.py`:

.. code:: python

   fa_brands_path = '_static/fa/brands.svg'
   fa_regular_path = '_static/fa/regular.svg'
   fa_solid_path = '_static/fa/solid.svg'

Use inline references for brands, regular or solid:

.. code:: rst

   Display an icon, with no alt text and aria-hidden:

   :fab:`icon`
   :far:`icon`
   :fas:`icon`

   :fab:`icon[alt text]`
   :far:`icon[alt text]`
   :fas:`icon[alt text]`

   An icon with some attributes:

   .. far:: icon
      :class: myclass
      :id: myid
      :alt: alt text

   For links with fasvglink and icon name as classes.
   This can be used to create fancy social links

   :fablink:`icon: Text <url>`
   :farlink:`icon: Text <url>`
   :faslink:`icon: Text <url>`

   :fablink:`icon: Text[alt text] <url>`
   :farlink:`icon: Text[alt text] <url>`
   :faslink:`icon: Text[alt text] <url>`

.. warning::

   Icon is not inserted in LaTeX document for now.
   It uses alt text for all builders except HTML and
   ePub.

By kujiu, EUPL 1.2 licence.

