diff --git a/.gitignore b/.gitignore index 7e99e367f..e2b3410f7 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ -*.pyc \ No newline at end of file +*.pyc +docs/_build/ +.DS_Store \ No newline at end of file diff --git a/docs/changelog.rst b/docs/changelog.rst index b2f415a5c..cbd003fb1 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -8,13 +8,15 @@ Changelog ========= -2.3.4 () -^^^^^^^^ +2.3.4 (not yet released) +------------------------ -* Some smaller bugfixes +* Moved |grappelli| to GitHub. +* Fixed a bug with the View on Site link with Tabular/Stacked inlines. +* Updated docs with the muellerdocs sphinx theme. 2.3.3 (28/05/2011) -^^^^^^^^^^^^^^^^^^ +------------------ * Documentation update * FileBrowser-related updates @@ -29,7 +31,7 @@ Changelog * Updated TinyMCE to 3.4.2 2.3.2 (16/02/2011) -^^^^^^^^^^^^^^^^^^ +------------------ * Some smaller bugfixes on the changelist. * Finally deleted folder ``media`` (media-files are now in ``static``). @@ -38,7 +40,7 @@ Changelog * Fixed a bug with using generic relations within generic-inlines (tabular and stacked). 2.3.1 (03/02/2011) -^^^^^^^^^^^^^^^^^^ +------------------ * Added ``related_lookup_fields`` for defining related lookups (fk, m2m, generic). * Fixed the limiation for using ``content_type_*`` and ``object_id_*`` with Generic Relations. diff --git a/docs/conf.py b/docs/conf.py index 06e84b976..9cfd24ed4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ # General information about the project. project = u'Django Grappelli' -copyright = u'2010, Patrick Kranzlmueller' +copyright = u'2011, Patrick Kranzlmueller' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -100,7 +100,7 @@ #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = ['.'] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/docs/customization.rst b/docs/customization.rst index 6911f723a..475f6e428 100644 --- a/docs/customization.rst +++ b/docs/customization.rst @@ -6,7 +6,7 @@ Customization ============= -While |grappelli| is mainly about the look & feel of the Admin-Interface, it also adds some features. +While |grappelli| is mainly about the look & feel of the admin interface, it also adds some features. .. _customizationsettings: @@ -14,7 +14,7 @@ Available Settings ------------------ ``GRAPPELLI_ADMIN_TITLE`` - The Site Title of your Admin-Interface. Change this instead of changing index.html + The Site Title of your admin interface. Change this instead of changing index.html .. _customizationadmin: @@ -101,7 +101,7 @@ With Grappelli, you're able to add the representation of an object beside the in } .. note:: - This is a workaround for a feature which should be implemented with the original admin-interface. + This is a workaround for a feature which should be implemented with the original admin interface. .. _customizationgenericrelationships: @@ -134,7 +134,7 @@ With Grappelli, you're able to add the representation of an object for Generic R } .. note:: - This is a workaround for a feature which should be implemented with the original admin-interface. + This is a workaround for a feature which should be implemented with the original admin interface. If your generic relation points to a model using a custom primary key, you need to add a property ``id``:: diff --git a/docs/dashboard_api.rst b/docs/dashboard_api.rst index 218b27514..287807d2b 100644 --- a/docs/dashboard_api.rst +++ b/docs/dashboard_api.rst @@ -100,7 +100,7 @@ Dashboard modules have the following properties: Default value: 'grappelli/dashboard/module.html'. The ``Group`` class ------------------------------------- +------------------- Represents a group of modules:: @@ -126,7 +126,7 @@ Represents a group of modules:: )) The ``LinkList`` class -------------------------------------- +---------------------- A module that displays a list of links. @@ -172,7 +172,7 @@ Here's an example of building a link list module:: )) The ``AppList`` class ------------------------------------- +--------------------- Module that lists installed apps and their models. As well as the :class:`~grappelli.dashboard.modules.DashboardModule` @@ -219,7 +219,7 @@ Here's an example of building an app list module:: the django.contrib.auth.Group model won't be displayed. The ``ModelList`` class --------------------------------------- +----------------------- Module that lists a set of models. As well as the :class:`~grappelli.dashboard.modules.DashboardModule` @@ -263,7 +263,7 @@ Here's a small example of building a model list module:: the django.contrib.auth.Group model won't be displayed. The ``RecentActions`` class ------------------------------------------- +--------------------------- Module that lists the recent actions for the current user. As well as the :class:`~grappelli.dashboard.modules.DashboardModule` @@ -298,7 +298,7 @@ Here's an example of building a recent actions module:: )) The ``Feed`` class ---------------------------------- +------------------ Class that represents a feed dashboard module. diff --git a/docs/dashboard_setup.rst b/docs/dashboard_setup.rst index 47800d7d9..d3098438a 100644 --- a/docs/dashboard_setup.rst +++ b/docs/dashboard_setup.rst @@ -8,13 +8,13 @@ Dashboard Setup .. versionadded:: 2.3 -With the Django Admin-Interface, the admin index page reflects the structure of your applications/models. With ``grappelli.dashboard`` you are able to change that structure and rearrange (or group) apps and models. +With the Django admin interface, the admin index page reflects the structure of your applications/models. With ``grappelli.dashboard`` you are able to change that structure and rearrange (or group) apps and models. .. note:: ``grappelli.dashboard`` is a simplified version of `Django Admin Tools `_: Bookmarks, Menus and the custom App-Index are **not available with Grappelli**. Add ``grappelli.dashboard`` to your Installed Apps -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------- Open ``settings.py`` and add ``grappelli.dashboard`` to your ``INSTALLED_APPS`` (before ``grappelli``):: @@ -25,7 +25,7 @@ Open ``settings.py`` and add ``grappelli.dashboard`` to your ``INSTALLED_APPS`` ) Add context-processors -^^^^^^^^^^^^^^^^^^^^^^ +---------------------- You need to add the request context-processor:: @@ -37,7 +37,7 @@ You need to add the request context-processor:: ) Create a custom Dashboard -^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------- To customize the index dashboard, you first need to add a custom dashboard:: @@ -56,7 +56,7 @@ Open your ``settings.py`` file and add the following:: GRAPPELLI_INDEX_DASHBOARD = 'yourproject.dashboard.CustomIndexDashboard' Create custom Dashboards for multiple admin sites -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------------------------------- If you have several admin sites, you need to create a custom dashboard for each site:: diff --git a/docs/djangoissues.rst b/docs/djangoissues.rst index ac1834800..441aa9e71 100644 --- a/docs/djangoissues.rst +++ b/docs/djangoissues.rst @@ -1,4 +1,4 @@ -:tocdepth: 1 +:tocdepth: 2 .. |grappelli| replace:: Grappelli .. |filebrowser| replace:: FileBrowser @@ -8,7 +8,7 @@ Django Issues ============= -There are some known problems with the Django admin-interface. I´m going to list them here in order to avoid confusion (because the problems are not related to Grappelli whatsoever). +There are some known problems with the Django admin interface. I´m going to list them here in order to avoid confusion (because the problems are not related to Grappelli whatsoever). see http://code.djangoproject.com/wiki/DjangoDesign @@ -16,7 +16,7 @@ Harcoded Stuff -------------- With "Hardcoded Stuff", I´m referring to HTML-Code within Views (instead of using Templates). -There´s a lot of this within the Admin-Interface and therefore it´s just not possible to style some elements. For other elements, we need to use ugly hacks or strange CSS. +There´s a lot of this within the admin interface and therefore it´s just not possible to style some elements. For other elements, we need to use ugly hacks or strange CSS. Javascripts ----------- @@ -28,14 +28,14 @@ see :ref:`Javascripts `. Reordering Edit-Inlines ----------------------- -First, the ``can_order`` attribute is not available with the admin-interface. Second, in case of errors, formsets are not returned in the right order. Therefore, reordering inlines is currently only possible with some hacks. +First, the ``can_order`` attribute is not available with the admin interface. Second, in case of errors, formsets are not returned in the right order. Therefore, reordering inlines is currently only possible with some hacks. see http://code.djangoproject.com/ticket/14238 Translating App Names --------------------- -It´s not possible to (easily) translate the names of apps within the admin-interface which leads to a strange language mix (esp. on the index page). +It´s not possible to (easily) translate the names of apps within the admin interface which leads to a strange language mix (esp. on the index page). see http://code.djangoproject.com/ticket/3591 and http://code.djangoproject.com/ticket/14251 @@ -52,7 +52,7 @@ Related Lookups With either ``raw_id_fields`` or ``Generic Relations``, the representation for an object should be displayed beneath the input-field. When changing the ``object-id`` (or selecting an object with the related pop-up window) the representation should be updated. -This issue is solved with Grappelli (unfortunately overly complex due to the limitations of the original admin-interface). +This issue is solved with Grappelli (unfortunately overly complex due to the limitations of the original admin interface). Autocompletes ------------- @@ -88,6 +88,6 @@ Translation of the Admin Documentation is half-baked. HTML/CSS Framework ------------------ -For the Admin-Interface to be customizable, flexible and extensible, we need a coherent HTML/CSS scheme. +For the admin interface to be customizable, flexible and extensible, we need a coherent HTML/CSS scheme. We do think that Grappelli is a first step. diff --git a/docs/faq.rst b/docs/faq.rst index 44d803f2c..7ebcd44f5 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,4 +1,4 @@ -:tocdepth: 1 +:tocdepth: 2 .. |grappelli| replace:: Grappelli .. |filebrowser| replace:: FileBrowser @@ -11,55 +11,45 @@ FAQ Some questions, some answers. Why should I use |grappelli|? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------- -If you are pleased with how the original Admin-Interface looks, you shouldn't. +If you are pleased with how the original admin interface looks, you shouldn't. I need help! -^^^^^^^^^^^^ +------------ see :ref:`Troubleshooting `. Which Browser do I need with Grappelli? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------------------- -We are testing with Firefox, Chrome and Safari. - -Why is there no mercurial– or git–repository? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -We have discussed this issue on the `Grappelli Google-Group `_. Since the outcome has been ambiguous, we stay with svn for now. +We are testing with Firefox, Chrome and Safari. IE9 and Opera should work fine as well. Can I use another editor than TinyMCE? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------- Of course. -Why don't you support Admin-Tools? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -`Django Admin Tools `_ is an awesome app, but it's just too much effort for us. - Do you guys cooperate with the Django–Devs? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------------------------- Occasionally, we discuss features and implementations. How can I contribute? -^^^^^^^^^^^^^^^^^^^^^ +--------------------- -Help is very much needed and appreciated. +Help is very much appreciated. -* Test |grappelli| and submit feedback/patches. +* Fork `django-grappelli `_ and submit feedback/patches. +* Work on `Django Tickets related to contrib.admin `_. * Take a look at :ref:`Django Issues `. -* Take a look at `Django Tickets related to django.contrib.admin `_. What is your goal with |grappelli|? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------- Our goal is that |grappelli| will be redundant eventually. Who develops |grappelli|? -^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------- |grappelli| is developed and maintained by Patrick Kranzlmüller & Axel Swoboda of `vonautomatisch `_. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 54341b618..006b6d2c9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,14 +5,17 @@ .. |grappelli| replace:: Grappelli .. |filebrowser| replace:: FileBrowser -Django Grappelli -================ +.. _index: + +Documentation +============= **A jazzy skin for the Django admin interface**. This documentation covers version 2.3.4 of |grappelli|. |grappelli| is a grid-based alternative/extension to the `Django `_ administration interface. -**Contents** +Installation & Setup +-------------------- .. toctree:: :maxdepth: 2 @@ -20,7 +23,8 @@ This documentation covers version 2.3.4 of |grappelli|. |grappelli| is a grid-ba quickstart customization -**Dashboard** +Dashboard +--------- .. toctree:: :maxdepth: 2 @@ -30,7 +34,8 @@ This documentation covers version 2.3.4 of |grappelli|. |grappelli| is a grid-ba dashboard_layout dashboard_extension -**Internals** +Internals +--------- .. toctree:: :maxdepth: 2 @@ -38,10 +43,11 @@ This documentation covers version 2.3.4 of |grappelli|. |grappelli| is a grid-ba templates javascripts -**Help** +Help +---- .. toctree:: - :maxdepth: 2 + :maxdepth: 1 faq thirdparty @@ -53,7 +59,7 @@ This documentation covers version 2.3.4 of |grappelli|. |grappelli| is a grid-ba Code ---- -http://code.google.com/p/django-grappelli/ +https://github.com/sehmaschine/django-grappelli Discussion ---------- diff --git a/docs/javascripts.rst b/docs/javascripts.rst index e761c9be5..cd61f9c38 100644 --- a/docs/javascripts.rst +++ b/docs/javascripts.rst @@ -16,7 +16,7 @@ Grappelli only uses a subset of the original admin javascripts. * If there are major modifications, we use our own files as well (e.g. ``jquery.grp_inlines.js``). Original JS -^^^^^^^^^^^ +----------- in ``/media/js/`` and ``/media/js/admin/`` @@ -46,7 +46,7 @@ in ``/media/js/`` and ``/media/js/admin/`` Grappelli JS -^^^^^^^^^^^^ +------------ in ``/media/js/grappelli/`` diff --git a/docs/quickstart.rst b/docs/quickstart.rst index b488e970e..d8d0882ba 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -8,29 +8,17 @@ Quick start guide For using |grappelli|, `Django `_ needs to be installed and an `Admin Site `_ has to be activated. -Download --------- - -Using ``easy_install``:: - - easy_install -Z django-grappelli - -Note that the ``-Z`` flag is required to tell ``easy_install`` not to -create a zipped package (zipped packages prevent certain features of -Django from working properly). +Installation +------------ Using ``pip``:: pip install django-grappelli -Using ``svn`` (recommended):: +Go to https://github.com/sehmaschine/django-grappelli if you need to download a package or clone the repo. - svn checkout http://django-grappelli.googlecode.com/svn/trunk/grappelli/ grappelli - -or download the package from http://code.google.com/p/django-grappelli/downloads/list - -Installation ------------- +Setup +----- Open ``settings.py`` and add ``grappelli`` to your ``INSTALLED_APPS`` (before ``django.contrib.admin``):: diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst index cfa1bc232..942475029 100644 --- a/docs/releasenotes.rst +++ b/docs/releasenotes.rst @@ -11,20 +11,20 @@ Grappelli 2.3.x Release Notes **Grappelli 2.3.x is compatible with Django 1.3**. We tried to simplify the codebase, cleaned up the javascripts and added this (sphinx-based) documentation. Overview -^^^^^^^^ +-------- * Javascript cleanup: we changed some js-locations and tried to use a consistent and comprehensible naming-scheme. Grappelli javascripts have been reworked as jQuery-plugins/widgets. See :ref:`Javascripts `. * Documentation: Added sphinx-based documentation. * Simplified the Installation. What's new in Grappelli 2.3.x -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------- * Drag/drop for Inlines, see :ref:`Inline Sortables `. * Grappelli Dashboard, see :ref:`Dashboard `. Deprecated in 2.3.x -^^^^^^^^^^^^^^^^^^^ +------------------- * Actions for CSV-Export. * Support for Admin-Tools. diff --git a/docs/thirdparty.rst b/docs/thirdparty.rst index bf7cecb76..1308fa690 100644 --- a/docs/thirdparty.rst +++ b/docs/thirdparty.rst @@ -8,10 +8,10 @@ Third Party Applications ======================== -A list of Third-Party Applications compatible with |grappelli|. +A list of 3rd-party applications compatible with |grappelli|. Django FileBrowser ------------------ -No additional setup is needed when installing the `Django FileBrowser `_ with Grappelli. +No additional setup is needed when installing the `Django FileBrowser `_ with Grappelli. diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 15b3b31f9..444208247 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -11,25 +11,25 @@ Troubleshooting Sometimes you might have a problem installing/using |grappelli|. Check your setup -^^^^^^^^^^^^^^^^ +---------------- First, please check if the problem is caused by your setup. * Read :ref:`quickstart` and :ref:`customization`. -* Check if the media-files are served correctly. +* Check if the static/media-files are served correctly. Check issues -^^^^^^^^^^^^ +------------ If your setup is fine, please check if your problem is a known issue. * Read :ref:`Django Issues ` in order to see if your problem is indeed related to |grappelli|. -* Take a look at all `Grappelli Issues `_ (incuding closed) and search the `Grappelli Google-Group `_. +* Take a look at all `Grappelli Issues `_ (incuding closed) and search the `Grappelli Google-Group `_. Add a ticket -^^^^^^^^^^^^ +------------ -If you think you've found a bug, please `add a ticket `_. +If you think you've found a bug, please `add a ticket `_. * Try to describe your problem as precisely as possible. * Tell us what you did in order to solve the problem.