sphinx_fontawesome 0.0.6

add directive for fontawesome in sphinx

sphinx fontawesome
##################

It is a extension for sphinx.

Add directive for use fontawesome

Installation
------------

::

pip install sphinx_fontawesome


Or

::

git clone https://github.com/fraoustin/sphinx_fontawesome.git
cd sphinx_fontawesome
python setup.py install

Use
---

In your conf.py

::

import sphinx_fontawesome
extensions = ['sphinx_fontawesome']

In your rst file, you can use

* directive

::

.. fa:: check

* role

::

:fa:`check`
:fa:`check lg`
:fa:`square-o`

* substitution

::

|check|
|square-o|

If you have changed the value of rst_prolog in your conf.py, 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': ["http://netdna.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"]
}

or create _templates/layout.html

::

{%- extends "yourtheme/layout.html" %}
{%- block extrahead %}
{{ super() }}
<link href="http://netdna.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" 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


0.0.5
=====

- correction setup.py not call sphinx_fontawesome

0.0.4
=====

- correction REQUIREMENT

0.0.3
=====

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

0.0.2
=====

- css for list of task in README
- manage alias

0.0.1
=====

initialize extension