Merge pull request #48 from SylvainCorlay/docs

Improve documentation

README.md

@@ -1,5 +1,7 @@
-QtAwesome
-=========
+# QtAwesome
+
+[![Build Status](https://travis-ci.org/spyder-ide/qtawesome.svg?branch=master)](https://travis-ci.org/spyder-ide/qtawesome)
+[![Documentation Status](https://readthedocs.org/projects/qtawesome/badge/?version=latest)](http://qtawesome.readthedocs.org/en/latest/?badge=latest)
 
 ## Description
 

docs/source/api_documentation.rst

@@ -0,0 +1,4 @@
+API Reference Documentation
+---------------------------
+
+.. automodule:: qtawesome

docs/source/index.rst

@@ -1,17 +1,9 @@
-qtawesome
-=========
-
-Contents:
+================================
+qtawesome: Iconic Fonts for PyQt
+================================
 
 .. toctree::
-   :maxdepth: 2
-
-   qtawesome
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
 
+   introduction
+   usage
+   api_documentation

docs/source/introduction.rst

@@ -0,0 +1,9 @@
+Introduction
+------------
+
+QtAwesome enables iconic fonts such as Font Awesome and Elusive Icons in PyQt
+and PySide applications.
+
+It started as a Python port of the QtAwesome_ C++ library by Rick Blommers.
+
+.. _QtAwesome: https://github.com/gamecreature/QtAwesome

docs/source/usage.rst

@@ -0,0 +1,58 @@
+Usage
+-----
+
+.. code:: python
+
+   import qtawesome as qta
+
+Use Font Awesome and Elusive Icons.
+
+.. code:: python
+
+    # Get icons by name.
+    fa_icon = qta.icon('fa.flag')
+    fa_button = QtGui.QPushButton(fa_icon, 'Font Awesome!')
+    asl_icon = qta.icon('ei.asl')
+    elusive_button = QtGui.QPushButton(asl_icon, 'Elusive Icons!')
+
+
+Apply some styling
+
+.. code:: python
+
+    # Styling icons
+    styling_icon = qta.icon('fa.music',
+                            active='fa.legal',
+                            color='blue',
+                            color_active='orange')
+
+    music_button = QtGui.QPushButton(styling_icon, 'Styling')
+
+Stack multiple icons
+
+.. code:: python
+
+    # Stacking icons
+    camera_ban = qta.icon('fa.camera', 'fa.ban',
+                          options=[{
+                              'scale_factor': 0.5,
+                              'active': 'fa.legal'
+                          }, {
+                              'color': 'red'
+                          }])
+    stack_button = QtGui.QPushButton(camera_ban, 'Stack')
+    stack_button.setIconSize(QtCore.QSize(32, 32))
+
+Animations
+
+.. code:: python
+
+    # Spining icons
+    spin_button = QtGui.QPushButton(' Spinning icon')
+    spin_icon = qta.icon('fa.spinner', color='red',
+                         animation=qta.Spin(spin_button))
+    spin_button.setIcon(spin_icon)
+
+Screenshot
+
+.. image:: ../../qtawesome-screenshot.gif