update docs

This commit is contained in:
tzangms 2013-05-07 16:23:12 +08:00
parent 0695b88bca
commit 4818566151
4 changed files with 42 additions and 15 deletions

1
.gitignore vendored
View File

@ -1,2 +1,3 @@
*.pyc
.DS_Store
docs/_build

View File

@ -4,33 +4,59 @@ Django bootstrap form
Generate twitter-bootstrap form output for django form
A 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/>`_
Screenshot
-----------
.. image:: _static/example.png
Installation
============
------------
Install django-bootstrap-form with pip
``$ pip install django-bootstrap-form``
.. code-block:: sh
$ pip install django-bootstrap-form
for people who still use older version before twitter bootstrap 2.0
``$ pip install django-bootstrap-form==0.2``
Configuration
==============
-------------
Add 'bootstrapform' to INSTALLED_APPS.
.. code-block:: python
INSTALLED_APPS = (
...
'bootstrapform',
...
)
Usage
=====
------
{% load bootstrap %}
.. code-block:: none
{{ form|bootstrap }}
{% load bootstrap %}
{{ form.<field name>|bootstrap }} - To output individual fields
{{ form|bootstrap }}
# or use with individual field
{{ form.<field name>|bootstrap }} - To output individual fields
CHANGELOG
---------
- 2013-5-7:
Add `radio` support for ChoiceField

BIN
docs/_static/example.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

View File

@ -41,16 +41,16 @@ master_doc = 'index'
# General information about the project.
project = u'django-bootstrap-form'
copyright = u'2012, tzangms'
copyright = u'2013, tzangms'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2.0.3'
version = '2.0.6'
# The full version, including alpha/beta/rc tags.
release = '2.0.3'
release = '2.0.6'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -91,7 +91,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the