debian-django-reversion/docs/index.rst

74 lines
1.2 KiB
ReStructuredText

.. _index:
django-reversion
================
**django-reversion** is an extension to the Django web framework that provides
version control for model instances.
Features
--------
- Roll back to any point in a model instance's history.
- Recover deleted model instances.
- Simple admin integration.
Installation
------------
To install django-reversion:
1. Install with pip: ``pip install django-reversion``.
2. Add ``'reversion'`` to ``INSTALLED_APPS``.
3. Run ``manage.py migrate``.
.. Important::
See :ref:`django-versions` if you're not using the latest release of Django.
Admin integration
-----------------
django-reversion can be used to add rollback and recovery to your admin site.
.. include:: /_include/admin.rst
For more information about admin integration, see :ref:`admin`.
Low-level API
-------------
You can use the django-reversion API to build version-controlled applications. See :ref:`api`.
More information
----------------
Installation
^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
django-versions
common-problems
changelog
Usage
^^^^^
.. toctree::
:maxdepth: 2
admin
commands
api
views
middleware
errors
signals