.. Django Grappelli documentation master file, created by
   sphinx-quickstart on Sun Dec  5 19:11:46 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
.. |grappelli| replace:: Grappelli
.. |filebrowser| replace:: FileBrowser
.. |grappelliversion| replace:: 4.0.1

.. _index:

Documentation
=============

**A jazzy skin for the Django admin interface**.

This documentation covers version |version| of |grappelli|. |grappelli| is a grid-based alternative/extension to the `Django <http://www.djangoproject.com>`_ administration interface.

.. note::
    |grappelli| |version| requires Django 5.0. More on :ref:`versions`.

Installation & Setup
--------------------

.. toctree::
   :maxdepth: 2

   quickstart
   customization

Dashboard
---------

.. toctree::
   :maxdepth: 2

   dashboard_setup
   dashboard_api

Internals
---------

.. toctree::
   :maxdepth: 2

   internals

Help
----

.. toctree::
   :maxdepth: 2

   help
   contributing
   changelog

Code
----

https://github.com/sehmaschine/django-grappelli

Website
-------

http://www.grappelliproject.com

Discussion
----------

Use the `Grappelli Google Group <http://groups.google.com/group/django-grappelli>`_ to ask questions or discuss features.

.. _versions:

Versions and Compatibility
--------------------------

**Grappelli is always developed against the latest stable Django release and is NOT tested with Django's master branch.**

* Grappelli 4.0.1 (April 25th, 2024): Compatible with Django 5.x
* Grappelli 3.0.9 (April 25th, 2024): Compatible with Django 4.2 (LTS)

Current development branches:

* Grappelli 4.0.2 (Development version for Django 5.0, see branch Stable/4.0.x)
* Grappelli 3.0.10 (Development version for Django 4.0, see branch Stable/3.0.x)

Older versions are available at GitHub, but are not supported anymore.