django-admin2/docs/index.rst
Daniel Greenfeld 5fb94b69be Document fixing
2013-05-18 18:09:59 +02:00

53 lines
1.1 KiB
ReStructuredText

Welcome to django-admin2's documentation!
=========================================
**django-admin2** aims to replace django's builtin admin that lives in
``django.contrib.admin``. Come and help us, have a look at the
:doc:`contributing` page and see our `GitHub`_ page.
Basic API
==============
Our goal is to make this API work:
.. code-block:: python
# 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
from djadmin2.models import ModelAdmin2
class UserAdmin2(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/pydanny/django-admin2
Content
-------
.. toctree::
:maxdepth: 2
contributing
design
meta
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`