Skip to main content

add directive for fontawesome in sphinx

Project description

sphinx fontawesome

It is a extension for sphinx.

Add directive for use fontawesome



pip install sphinx_fontawesome



git clone
cd sphinx_fontawesome
python install


In your


import sphinx_fontawesome
extensions = ['sphinx_fontawesome']

In your rst file, you can use

* directive


.. fa:: check

* role


:fa:`check lg`

* substitution



If you have changed the value of rst_prolog in your, and you'd like to use subsitution you
can add ``sphinx_fontawesome.prolog`` to it.


rst_prolog = sphinx_fontawesome.prolog + "my prolog"

For add css fontawesome, you can cssfiles option of your theme


html_theme_options = {
'cssfiles': [""]

or create _templates/layout.html


{%- extends "yourtheme/layout.html" %}
{%- block extrahead %}
{{ super() }}
<link href="" rel="stylesheet">
{% endblock %}

You can generate todo list if you add in css (as font-awesome css)

table.field-list th.field-name {
color: white;

table.field-list th.field-name .fa {
color: black;

and write todo list


:|o|: task 1
:|x|: task 2
:|x|: task 3


- correction not call sphinx_fontawesome


- correction REQUIREMENT


- add newline after prolog
- update list icons
- update version css in README


- css for list of task in README
- manage alias


initialize extension

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx_fontawesome, version 0.0.6
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_fontawesome-0.0.6.tar.gz (22.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page