Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
mainly changed the links from google-code to github
  • Loading branch information
sehmaschine committed Aug 1, 2011
1 parent 017d496 commit 7de89e5
Show file tree
Hide file tree
Showing 14 changed files with 81 additions and 93 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
*.pyc
*.pyc
docs/_build/
.DS_Store
14 changes: 8 additions & 6 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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``).
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
# "<project> v<release> documentation".
Expand Down
8 changes: 4 additions & 4 deletions docs/customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
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:

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:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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``::

Expand Down
12 changes: 6 additions & 6 deletions docs/dashboard_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Dashboard modules have the following properties:
Default value: 'grappelli/dashboard/module.html'.

The ``Group`` class
------------------------------------
-------------------

Represents a group of modules::

Expand All @@ -126,7 +126,7 @@ Represents a group of modules::
))

The ``LinkList`` class
-------------------------------------
----------------------

A module that displays a list of links.

Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -298,7 +298,7 @@ Here's an example of building a recent actions module::
))

The ``Feed`` class
---------------------------------
------------------

Class that represents a feed dashboard module.

Expand Down
10 changes: 5 additions & 5 deletions docs/dashboard_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://packages.python.org/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``)::

Expand All @@ -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::

Expand All @@ -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::
Expand All @@ -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::

Expand Down
14 changes: 7 additions & 7 deletions docs/djangoissues.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:tocdepth: 1
:tocdepth: 2

.. |grappelli| replace:: Grappelli
.. |filebrowser| replace:: FileBrowser
Expand All @@ -8,15 +8,15 @@
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

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
-----------
Expand All @@ -28,14 +28,14 @@ see :ref:`Javascripts <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

Expand All @@ -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
-------------
Expand Down Expand Up @@ -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.
38 changes: 14 additions & 24 deletions docs/faq.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:tocdepth: 1
:tocdepth: 2

.. |grappelli| replace:: Grappelli
.. |filebrowser| replace:: FileBrowser
Expand All @@ -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 <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 <http://groups.google.com/group/django-grappelli>`_. 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 <http://packages.python.org/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 <https://github.com/sehmaschine/django-grappelli>`_ and submit feedback/patches.
* Work on `Django Tickets related to contrib.admin <https://code.djangoproject.com/query?status=assigned&status=new&status=reopened&component=contrib.admin&group=milestone&col=id&col=summary&col=status&col=owner&col=type&col=version&order=priority>`_.
* Take a look at :ref:`Django Issues <djangoissues>`.
* Take a look at `Django Tickets related to django.contrib.admin <http://code.djangoproject.com/query?status=new&status=assigned&status=reopened&group=milestone&component=django.contrib.admin&order=priority>`_.

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 <http://www.vonautomatisch.at>`_.
22 changes: 14 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,26 @@
.. |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 <http://www.djangoproject.com>`_ administration interface.

**Contents**
Installation & Setup
--------------------

.. toctree::
:maxdepth: 2

quickstart
customization

**Dashboard**
Dashboard
---------

.. toctree::
:maxdepth: 2
Expand All @@ -30,18 +34,20 @@ This documentation covers version 2.3.4 of |grappelli|. |grappelli| is a grid-ba
dashboard_layout
dashboard_extension

**Internals**
Internals
---------

.. toctree::
:maxdepth: 2

templates
javascripts

**Help**
Help
----

.. toctree::
:maxdepth: 2
:maxdepth: 1

faq
thirdparty
Expand All @@ -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
----------
Expand Down
Loading

0 comments on commit 7de89e5

Please sign in to comment.