diff --git a/.gitignore b/.gitignore index 6d582b3..7ef72bb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.pyc +.DS_Store docs/_build diff --git a/README.rst b/README.rst index 04d5849..43ae4a9 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ + + +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.|bootstrap }} - To output individual fields + {{ form|bootstrap }} + + # or use with individual field + + {{ form.|bootstrap }} - To output individual fields + +CHANGELOG +--------- + +- 2013-5-7: + + Add `radio` support for ChoiceField diff --git a/docs/_static/example.png b/docs/_static/example.png new file mode 100644 index 0000000..f5b4645 Binary files /dev/null and b/docs/_static/example.png differ diff --git a/docs/conf.py b/docs/conf.py index 8fd9bae..53b7c9e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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