.. default-domain:: py

================================================
django-tables2 - An app for creating HTML tables
================================================

Its features include:

- Any iterable can be a data-source, but special support for Django querysets is included.
- The builtin UI does not rely on JavaScript.
- Support for automatic table generation based on a Django model.
- Supports custom column functionality via subclassing.
- Pagination.
- Column based table sorting.
- Template tag to enable trivial rendering to HTML.
- Generic view mixin.


About the app:

- `Available on pypi <https://pypi.python.org/pypi/django-tables2>`_
- Tested with python 2.7, 3.4, 3.5, 3.6 and Django 1.11, `Travis CI <https://travis-ci.org/jieter/django-tables2>`_
- `Documentation on readthedocs.org <https://django-tables2.readthedocs.io/en/latest/>`_
- `Bug tracker <http://github.com/jieter/django-tables2/issues>`_


Table of contents
-----------------

.. toctree::
    :maxdepth: 1
    :caption: Getting started

    pages/installation
    pages/tutorial
    pages/table-data

.. toctree::
    :maxdepth: 1
    :caption: Customisation

    pages/custom-data
    pages/ordering
    pages/column-attributes
    pages/column-headers-and-footers
    pages/swapping-columns
    pages/pagination
    pages/table-mixins
    pages/custom-rendering
    pages/query-string-fields
    pages/localization-control
    pages/generic-mixins
    pages/pinned-rows
    pages/filtering
    pages/export

.. toctree::
    :maxdepth: 1
    :caption: Reference

    pages/reference
    pages/faq
    pages/upgrade-changelog
    pages/glossary
