Skip to content

Commit

Permalink
Update doc to close #24
Browse files Browse the repository at this point in the history
  • Loading branch information
sveetch committed Sep 12, 2015
1 parent 115f5b8 commit d4f808c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 31 deletions.
25 changes: 0 additions & 25 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,3 @@ Requires
========

* `django-crispy-forms`_ = 1.4.x;

Installation
============

Just register the app in your project settings like that :

.. sourcecode:: python

INSTALLED_APPS = (
...
'crispy_forms',
'crispy_forms_foundation',
...
)

Then append this part to specify usage of the Foundation set :

.. sourcecode:: python

# Default layout to use with "crispy_forms"
CRISPY_TEMPLATE_PACK = 'foundation-5'

If not defined, the default template pack name used is ``foundation-5``, also there is a basic ``foundation-3`` support but it's not be maintained anymore.

All other `django-crispy-forms`_ settings option apply, see its documentation for more details.
4 changes: 1 addition & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

.. crispy-form-foundation documentation master file, created by
sphinx-quickstart on Sat Nov 15 20:21:48 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to crispy-form-foundation's documentation!
==================================================
Expand All @@ -28,7 +26,7 @@ Links
Requires
========

* `django-crispy-forms`_ = 1.4.x;
* `django-crispy-forms`_ >= 1.4.x;

Table of contents
*****************
Expand Down
12 changes: 9 additions & 3 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
Install
=======

Register the app in your project settings like that :
Get it from PyPi: ::

pip install crispy-forms-foundation

Register the app in your project settings :

.. sourcecode:: python

Expand All @@ -20,10 +24,12 @@ Register the app in your project settings like that :
Then append this part to specify usage of the Foundation set :

.. sourcecode:: python


# Add 'foundation-5' layout pack
CRISPY_ALLOWED_TEMPLATE_PACKS = ('bootstrap', 'uni_form', 'bootstrap3', 'foundation-5')
# Default layout to use with "crispy_forms"
CRISPY_TEMPLATE_PACK = 'foundation-5'

If not defined, the default template pack name used is ``foundation-5``, also you can use ``foundation-3`` but pay attention that is not really maintained.
The default template pack name used will be ``foundation-5``.

All other `django-crispy-forms`_ settings option apply, see its documentation for more details.

0 comments on commit d4f808c

Please sign in to comment.