From e5a140eeb2f37561dbd5cae2a11af377d7ee1cb4 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Sat, 18 May 2013 13:30:45 +0200 Subject: [PATCH] Additional documentation --- README.rst | 2 +- docs/index.rst | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 472e4d0..2887b77 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ Our goal is to make this API work: # myapp/admin2.py # Import the Admin2 base class - from admin2.sites import Admin2 + from admin2.models import Admin2 # Import your custom models from blog.models import Post diff --git a/docs/index.rst b/docs/index.rst index 78f0aaf..33ef23c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,26 @@ Welcome to django-admin2's documentation! ``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 + + # myapp/admin2.py + + # Import the Admin2 base class + from djadmin2.models import Admin2 + + # Import your custom models + from blog.models import Post + + # Instantiate the Admin2 class + # Then attach the admin2 object to your model + Post.admin2 = Admin2() + + .. _GitHub: https://github.com/pydanny/django-admin2 Content