.. index::
   pair: Sphinx; Flask Funnel

.. _flask_funnel:

==========================
Flask Funnel
==========================

.. seealso::

   - https://github.com/rehandalal/flask-funnel

.. contents::
   :depth: 3

Summary
=======

A Flask extension for compressing/minifying assets.

A Flask-Script submanager is also provided.


Documentation
=============

Documentation is at
`<http://flask-funnel.readthedocs.org/en/latest/>`_.


Install
=======

To install::

    $ pip install Flask-Funnel


You can also install the development version
`<https://github.com/rehandalal/flask-funnel/tarball/master#egg=Flask-Funnel-dev>`_::

    $ pip install Flask-Funnel==dev


or::

    $ git clone git://github.com/rehandalal/flask-funnel.git
    $ mkvirtualenv flaskfunnel
    $ python setup.py develop
    $ pip install -r requirements.txt


Test
====

To run tests from a tarball or git clone::

    $ python setup.py test

.. _flask_funnel_theme:

Flask funnel Sphinx theme (flask small)
=======================================

.. seealso::

   - https://github.com/writethedocs/docs/blob/master/docs/conf.py
   - http://docs.writethedocs.org/en/2013/
   - :ref:`flask_small`