Playing aorund with indexes and making the pages look better

ericholscher · Jan 17, 2009 · 73374c1 · 73374c1
1 parent d481e7c
commit 73374c1
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 46 deletions.
diff --git a/apps/distrobution.txt b/apps/distrobution.txt
diff --git a/apps/index.txt b/apps/index.txt
@@ -1,6 +1,6 @@
 .. _apps-index:
 
-Django Reusable App Project Documentation
+Django Reusable App Conventions
 ==========================================
 
 Contents:

diff --git a/apps/overview.txt b/apps/overview.txt
diff --git a/coding_conventions.txt b/coding_conventions.txt
diff --git a/index.txt b/index.txt
@@ -1,12 +1,42 @@
 .. _index:
 
-Django reusable app documentation
+.. index::
+   pair: What are; Reusable Apps
+   triple: James Bennett; Djangocon Talk; Reusable Apps
+
+What is a reusable app?
+=======================
+
+A reusable Django app, is an app that is easily plugged into a
+project, providing a very specific piece of functionality. They should
+be focused and follow the Unix philosophy of "Do one thing and do it
+well." Please refer to James Bennett's `Djangocon talk
+<http://www.youtube.com/watch?v=A-S0tqpPga4>`__ on the subject for
+more info.
+
+.. index:: Coding Conventions, PEP8
+   pair: Python; Coding Conventions
+   pair: Django; Coding Conventions
+
+
+Coding Conventions
+==================
+
++ All code should follow `PEP8
+  <http://www.python.org/dev/peps/pep-0008/>`__ as closely as
+  reasonable.
++ All code should preferably follow Django's `coding conventions
+  <http://docs.djangoproject.com/en/dev/internals/contributing/#coding-
+  style>`__ as well.
+
+
+Django Conventions
 =================================
 
 .. toctree::
   :maxdepth: 2
 
-  coding_conventions
+  distribution
   apps/index
   projects/index
 

diff --git a/projects/index.txt b/projects/index.txt
@@ -1,6 +1,6 @@
 .. _projects-index:
 
-Django Reusable App Project Documentation
+Django Project Conventions
 ==========================================
 
 Contents:

diff --git a/projects/overview.txt b/projects/overview.txt
@@ -14,7 +14,7 @@ Suggested Project layout
 
 .. sourcecode:: python
 
-     `example.com/
+     example.com/
         settings.py
         urls.py
         local_apps/
@@ -45,4 +45,3 @@ Suggested Project layout
             example/
             app1/
             app2/
-    `