Skip to main content

Install the module :

python setup.py install

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

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:

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

By kujiu, EUPL 1.2 licence.

Metadata

Release files for sphinx-fasvg 2.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-fasvg 2.0.2
File Size Uploaded
sphinx_fasvg-2.0.2.tar.gz 24.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-fasvg 2.0.2
File Interpreter ABI Platform
sphinx_fasvg-2.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 49.8 kB

Release files / sphinx_fasvg-2.0.2.tar.gz

Download URL sphinx_fasvg-2.0.2.tar.gz
Size 24.3 kB
Tags Source
SHA-256 checksum
How to use checksums
42d167d16e7a8407b4f7745a1013b1131237d5538af680ce1ee887170fc1b5fa
BLAKE2b-256 checksum
How to use checksums
a298461d5cbde7cfc3b0c917a550b1fae0e5b3cd6bacd4eeef58e642e8ffb875
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release files / sphinx_fasvg-2.0.2-py3-none-any.whl

Download URL sphinx_fasvg-2.0.2-py3-none-any.whl
Size 25.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2be709c5139f7a17112dc6a9252cb67a4da78809d6fcebb1e8136943a915bd71
BLAKE2b-256 checksum
How to use checksums
bf00803a4b6186d9021bb5a0025d7c75eb1a1122ac0fdbe33eaee2b9cd1273e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release history Release notifications | RSS feed

This release

2.0.2 This release

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.0.0

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page