Little bit of cleanup, added toplevel coding conventions

ericholscher · Jan 16, 2009 · ff6ba46 · ff6ba46
1 parent a7b46a1
commit ff6ba46
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 30 deletions.
diff --git a/README b/README
@@ -1,4 +1,3 @@
-
 This project is meant to hold documentation on how to build and maintain
 Django reusable apps.
 

diff --git a/apps/apps.txt b/apps/apps.txt
diff --git a/coding_conventions.txt b/coding_conventions.txt
@@ -0,0 +1,11 @@
+.. _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.
diff --git a/index.txt b/index.txt
@@ -5,6 +5,7 @@ Django reusable app documentation
 
 Contents:
 
+   * :ref:`Coding Conventions <coding-conventions>`
    * :ref:`Projects Index <projects-index>`
    * :ref:`Apps Index <apps-index>`