Merge pull request #93 from audreyr/theming-89

Write theming docs. Close issue #89.
jazzband · May 19, 2013 · c638a85 · c638a85
2 parents 26cb6f1 + 4f8e6b4
commit c638a85
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -63,6 +63,7 @@ Content
    contributing
    api
    design
+   themes
    meta
 
 

diff --git a/docs/themes.rst b/docs/themes.rst
@@ -0,0 +1,30 @@
+======
+Themes
+======
+
+How To Create a Theme
+---------------------
+
+A theme consists of 3 parts. Here's how you set those up:
+
+1. Static files: create a directory in djadmin2/static/themes/ called your-theme-name/. Put your static files in there.
+
+2. Templates: create a directory in djadmin2/templates/admin2/bootstrap/ called your-theme-name/. Copy the template files from the bootstrap theme into there and then modify them as you'd like.
+
+3. Your settings file should point to your theme directory::
+
+    ADMIN2_THEME_DIRECTORY = "admin2/bootstrap/"
+
+Look at the "bootstrap" theme as an example. If you run into any problems, please file an issue.
+
+Available Themes
+----------------
+
+Currently, only the "bootstrap" theme exists. The goal of this theme is to replicate the original Django admin UI functionality as closely as possible. This helps us ensure that we are not forgetting any functionality that Django users might be dependent on.
+
+If you'd like to experiment with UI design that differs from the original Django admin UI, please create a new theme. It would be great to have at least 1 experimental theme!
+
+Future
+------
+
+Keep in mind that this project is an experiment just to get our ideas down. We are looking at other similar projects to see if we can merge or borrow things.