Fixes to documentation and tests

.travis.yml

@@ -1,6 +1,5 @@
-language: python
-
 # Python versions for matrix
+language: python
 python:
   - "2.7"
   - "2.6"
@@ -9,9 +8,9 @@ python:
 
 # Django versions for matrix
 env:
-  - DJANGO_VERSION=1.4.10
-  - DJANGO_VERSION=1.5.5
-  - DJANGO_VERSION=1.6.2
+  - DJANGO_VERSION=1.4.12
+  - DJANGO_VERSION=1.5.7
+  - DJANGO_VERSION=1.6.4
 
 # Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
 install:
@@ -25,10 +24,15 @@ script:
 matrix:
   exclude:
     - python: "3.2"
-      env: DJANGO_VERSION=1.4.10
+      env: DJANGO_VERSION=1.4.12
     - python: "3.3"
-      env: DJANGO_VERSION=1.4.10
+      env: DJANGO_VERSION=1.4.12
     - python: "3.2"
-      env: DJANGO_VERSION=1.5.5
+      env: DJANGO_VERSION=1.5.7
     - python: "3.3"
-      env: DJANGO_VERSION=1.5.5
+      env: DJANGO_VERSION=1.5.7
+
+# Report to coveralls
+after_success:
+  - pip install --quiet python-coveralls
+  - coveralls

AUTHORS.rst

@@ -1,25 +1,25 @@
 =======
-Credits
+Authors
 =======
 
 Development Lead
 ----------------
 
-* Dylan Verheul <dylan.verheul@gmail.com>
+* Dylan Verheul <dylan@dyve.net>
 
 Contributors
 ------------
 
-Allard Stijnman <a.g.stijnman@gmail.com>
-Austin Whittier <austin.whitt@gmail.com>
-Caio Ariede <caio.ariede@gmail.com>
-Fabio C. Barrionuevo da Luz <bnafta@gmail.com>
-Jay Pipes <jaypipes@gmail.com>
-Jonas Hagstedt <hagstedt@gmail.com>
-Jordan Starcher <jstarcher@gmail.com>
-Juan Carlos <juancarlospaco@gmail.com>
-Markus Holtermann <info@markusholtermann.eu>
-Nick S <nsmith448@gmail.com>
-Owais Lone <loneowais@gmail.com>
-Richard Hajdu <tuskone16@gmail.com>
-pmav99 <pmav99@users.noreply.github.com> 
+* Allard Stijnman <a.g.stijnman@gmail.com>
+* Austin Whittier <austin.whitt@gmail.com>
+* Caio Ariede <caio.ariede@gmail.com>
+* Fabio C. Barrionuevo da Luz <bnafta@gmail.com>
+* Jay Pipes <jaypipes@gmail.com>
+* Jonas Hagstedt <hagstedt@gmail.com>
+* Jordan Starcher <jstarcher@gmail.com>
+* Juan Carlos <juancarlospaco@gmail.com>
+* Markus Holtermann <info@markusholtermann.eu>
+* Nick S <nsmith448@gmail.com>
+* Owais Lone <loneowais@gmail.com>
+* Richard Hajdu <tuskone16@gmail.com>
+* pmav99 <pmav99@users.noreply.github.com>

README.rst

@@ -1,6 +1,6 @@
-=================
-django-bootstrap3
-=================
+============================
+Welcome to django-bootstrap3
+============================
 
 .. image:: https://travis-ci.org/dyve/django-bootstrap3.png?branch=master
     :target: https://travis-ci.org/dyve/django-bootstrap3
@@ -11,17 +11,12 @@ django-bootstrap3
 .. image:: https://pypip.in/d/django-bootstrap3/badge.png
     :target: https://crate.io/packages/django-bootstrap3?version=latest
 
-Bootstrap support for Django projects
 
-**You can support this project on GitTip, https://www.gittip.com/dyve/.**
-
-Documentation
--------------
+Use Bootstrap in your Django templates, the Django way.
 
-The full documentation is at http://django-bootstrap3.readthedocs.org/.
 
-Quickstart
-----------
+Installation
+------------
 
 1. Install using pip:
 
@@ -35,17 +30,13 @@ Quickstart
 
 3. In your templates, load the ``bootstrap3`` library and use the ``bootstrap_*`` tags:
 
-   .. code:: Django
-
-    {% load bootstrap3 %}
 
-    {# Load CSS and JavaScript #}
+Example template
+----------------
 
-    {% bootstrap_css %}
-    {% bootstrap_javascript %}
+   .. code:: Django
 
-    {# Display django.contrib.messages as Bootstrap alerts #}
-    {% bootstrap_messages %}
+    {% load bootstrap3 %}
 
     {# Display a form #}
 
@@ -60,11 +51,10 @@ Quickstart
     </form>
 
 
+Documentation
+-------------
 
-Features
---------
-
-Define your forms in Django, use ``django-bootstrap3`` to render them in Bootstrap. That's the dream.
+The full documentation is at http://django-bootstrap3.readthedocs.org/.
 
 
 Requirements
@@ -89,6 +79,7 @@ License
 
 You can use this under Apache 2.0. See LICENSE file for details.
 
+
 Author
 ------
 

docs/conf.py

@@ -130,7 +130,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/example_template.rst

@@ -0,0 +1,24 @@
+.. code:: django
+
+    {# Load the tag library #}
+	{% load bootstrap3 %}
+
+	{# Load CSS and JavaScript #}
+	{% bootstrap_css %}
+	{% bootstrap_javascript %}
+
+	{# Display django.contrib.messages as Bootstrap alerts #}
+	{% bootstrap_messages %}
+
+	{# Display a form #}
+	<form action="/url/to/submit/" method="post" class="form">
+	    {% csrf_token %}
+	    {% bootstrap_form form %}
+	    {% buttons %}
+		<button type="submit" class="btn btn-primary">
+		    {% bootstrap_icon "star" %} Submit
+		</button>
+	    {% endbuttons %}
+	</form>
+
+    {# Read the documentation for more information #}

docs/index.rst

@@ -11,10 +11,10 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   readme
    installation
-   settingsoptions
+   quickstart
    templatetags
+   settings
    contributing
    authors
    history

docs/installation.rst

@@ -2,11 +2,16 @@
 Installation
 ============
 
-At the command line::
+The preferred way to install ``django-bootstrap3 ``pip`` to install::
 
-    $ easy_install django-bootstrap3
+    $ pip install django-bootstrap3
 
-Or, if you have virtualenvwrapper installed::
+Alternatively, you can install download or clone this repo and install from its folder with::
 
-    $ mkvirtualenv django-bootstrap3
-    $ pip install django-bootstrap3
+    $ pip install -e .
+
+In your project, you should add ``django-bootstrap3`` to your ``requirements.txt``.
+
+Be sure to use ``virtualenv`` if you develop python projects.
+
+After installation, the :doc:`quickstart` will get you on your way to using ``django-bootstrap3``.

docs/quickstart.rst

@@ -0,0 +1,25 @@
+==========
+Quickstart
+==========
+
+After :doc:`installation`, you can use ``django-bootstrap3`` in your templates.:
+
+Load the ``bootstrap3`` library and use the ``bootstrap_*`` tags:
+
+
+Example template
+----------------
+
+.. include:: example_template.rst
+
+
+Template tags and filters
+-------------------------
+
+Refer to :doc:`templatetags` for more information.
+
+
+Settings
+--------
+
+You can set defaults for ``django-bootstrap3`` in your settings file. Refer to :doc:`settings` for more information.

docs/settings.rst

@@ -0,0 +1,35 @@
+========
+Settings
+========
+
+The django-bootstrap3 has some pre-configured settings.
+
+They can be modified by adding a dict variable called ``BOOTSTRAP3`` in your ``settings.py`` and customizing the values ​​you want;
+
+The ``BOOTSTRAP3`` dict variable is configured by default to the following values​​:
+
+
+.. code:: django
+
+    # Default settings
+    BOOTSTRAP3_DEFAULTS = {
+        'jquery_url': '//code.jquery.com/jquery.min.js',
+        'base_url': '//netdna.bootstrapcdn.com/bootstrap/3.1.1/',
+        'css_url': None,
+        'theme_url': None,
+        'javascript_url': None,
+        'javascript_in_head': False,
+        'include_jquery': False,
+        'horizontal_label_class': 'col-md-2',
+        'horizontal_field_class': 'col-md-4',
+        'set_required': True,
+        'form_required_class': '',
+        'form_error_class': '',
+        'form_renderers': {
+            'default': 'bootstrap3.renderers.FormRenderer',
+        },
+        'field_renderers': {
+            'default': 'bootstrap3.renderers.FieldRenderer',
+            'inline': 'bootstrap3.renderers.InlineFieldRenderer',
+        },
+    }