.. PyWaffle documentation master file, created by
   sphinx-quickstart on Wed Nov 22 16:25:01 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyWaffle Documentation
======================

PyWaffle is an open source, MIT-licensed Python package for plotting waffle charts.

A `Figure constructor
<https://matplotlib.org/gallery/subplots_axes_and_figures/custom_figure_class.html>`_ class *Waffle* is provided, which could be passed to matplotlib.pyplot.figure and generate a matplotlib Figure object.

Visit PyWaffle on `Github
<https://github.com/gyli/PyWaffle>`_ and `PyPI
<https://pypi.org/project/pywaffle/>`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   examples
   font_awesome_integration
   class