django-admin2/docs/index.rst
Daniel Greenfeld 16c9b8c3ee prep for v0.3.0
2013-05-31 10:21:02 +02:00

73 lines
1.4 KiB
ReStructuredText

Welcome to django-admin2's documentation!
=========================================
**django-admin2** aims to replace django's built-in admin that lives in
``django.contrib.admin``. Come and help us, have a look at the
:doc:`contributing` page and see our `GitHub`_ page.
This project is intentionally backwards-incompatible with ``django.contrib.admin``.
Requirements
=============
* Django 1.5+
* Python 2.7+ or Python 3.3+
* django-braces
* django-extra-views
* django-floppyforms
* django-rest-framework
* Sphinx (for documentation)
Basic API
==============
Our goal is to make this API work:
.. code-block:: python
# myapp/admin2.py
# Import your custom models
from .models import Post, Comment
from django.contrib.auth.forms import UserCreationForm, UserChangeForm
from django.contrib.auth.models import User
import djadmin2
class UserAdmin2(djadmin2.ModelAdmin2):
create_form_class = UserCreationForm
update_form_class = UserChangeForm
# Register each model with the admin
djadmin2.default.register(Post)
djadmin2.default.register(Comment)
djadmin2.default.register(User, UserAdmin2)
.. _GitHub: https://github.com/twoscoops/django-admin2
Content
-------
.. toctree::
:maxdepth: 2
contributing
design
architecture
api
themes
meta
reference
tutorial
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`