update README and docs
This commit is contained in:
parent
4818566151
commit
a669e26760
55
README.rst
55
README.rst
@ -6,57 +6,4 @@ Generate twitter-bootstrap form output for django form
|
|||||||
|
|
||||||
A simple Django template tag to work with twitter bootstrap ( http://twitter.github.com/bootstrap/ )
|
A simple Django template tag to work with twitter bootstrap ( http://twitter.github.com/bootstrap/ )
|
||||||
|
|
||||||
`readthedocs <https://django-bootstrap-form.readthedocs.org/en/latest/>`_
|
`Read the Docs <https://django-bootstrap-form.readthedocs.org/en/latest/>`_
|
||||||
|
|
||||||
|
|
||||||
Screenshot
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. image:: _static/example.png
|
|
||||||
|
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
Install django-bootstrap-form with pip
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
$ pip install django-bootstrap-form
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Configuration
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Add 'bootstrapform' to INSTALLED_APPS.
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
INSTALLED_APPS = (
|
|
||||||
...
|
|
||||||
'bootstrapform',
|
|
||||||
...
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
Usage
|
|
||||||
------
|
|
||||||
|
|
||||||
.. code-block:: none
|
|
||||||
|
|
||||||
{% load bootstrap %}
|
|
||||||
|
|
||||||
{{ form|bootstrap }}
|
|
||||||
|
|
||||||
# or use with individual field
|
|
||||||
|
|
||||||
{{ form.<field name>|bootstrap }} - To output individual fields
|
|
||||||
|
|
||||||
CHANGELOG
|
|
||||||
---------
|
|
||||||
|
|
||||||
- 2013-5-7:
|
|
||||||
|
|
||||||
Add `radio` support for ChoiceField
|
|
||||||
|
@ -10,7 +10,7 @@ Welcome to django bootstrap form's documentation!
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
|
||||||
.. include:: ../README.rst
|
.. include:: install.rst
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
61
docs/install.rst
Normal file
61
docs/install.rst
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
=====================
|
||||||
|
Django bootstrap form
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Generate twitter-bootstrap form output for django form
|
||||||
|
|
||||||
|
A simple Django template tag to work with twitter bootstrap ( http://twitter.github.com/bootstrap/ )
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Screenshot
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. image:: _static/example.png
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
Install django-bootstrap-form with pip
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
$ pip install django-bootstrap-form
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Add 'bootstrapform' to INSTALLED_APPS.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
INSTALLED_APPS = (
|
||||||
|
...
|
||||||
|
'bootstrapform',
|
||||||
|
...
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
Usage
|
||||||
|
------
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
{% load bootstrap %}
|
||||||
|
|
||||||
|
{{ form|bootstrap }}
|
||||||
|
|
||||||
|
# or use with individual field
|
||||||
|
|
||||||
|
{{ form.<field name>|bootstrap }} - To output individual fields
|
||||||
|
|
||||||
|
CHANGELOG
|
||||||
|
---------
|
||||||
|
|
||||||
|
- 2013-5-7:
|
||||||
|
|
||||||
|
Add `radio` support for ChoiceField
|
Loading…
Reference in New Issue
Block a user