From 73374c157625be2b51871a92248a3ada7d559787 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Sat, 17 Jan 2009 01:06:37 -0600 Subject: [PATCH] Playing aorund with indexes and making the pages look better --- apps/distrobution.txt | 18 ------------------ apps/index.txt | 2 +- apps/overview.txt | 11 ----------- coding_conventions.txt | 11 ----------- index.txt | 34 ++++++++++++++++++++++++++++++++-- projects/index.txt | 2 +- projects/overview.txt | 3 +-- 7 files changed, 35 insertions(+), 46 deletions(-) delete mode 100644 apps/distrobution.txt delete mode 100644 apps/overview.txt delete mode 100644 coding_conventions.txt diff --git a/apps/distrobution.txt b/apps/distrobution.txt deleted file mode 100644 index 138a000..0000000 --- a/apps/distrobution.txt +++ /dev/null @@ -1,18 +0,0 @@ -.. _apps-distribution: - -How do I distribute my app? -=========================== - -Django should be using the standard `Python Package Index -`__ aka Pypi or the Cheese Shop. I wrote -a `tutorial `__ about how to easily package -and upload your app to Pypi. All reusable apps should be uploading to -Pypi. - -If you upload your app to Pypi, it is generally a good idea to prefix -your project name with "django-" - -Also note, that when below when we refer to the default place for -something as a file, that also means that you can make a directory of -that same name; as per normal python. diff --git a/apps/index.txt b/apps/index.txt index b6fb9f3..05bed75 100644 --- 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 deleted file mode 100644 index d740660..0000000 --- a/apps/overview.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. _apps-overview: - -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 -`__ on the subject for -more info. diff --git a/coding_conventions.txt b/coding_conventions.txt deleted file mode 100644 index f468ca4..0000000 --- a/coding_conventions.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. _coding-conventions: - -Coding conventions -================== - -+ All code should follow `PEP8 - `__ as closely as - reasonable. -+ All code should preferably follow Django's `coding conventions - `__ as well. diff --git a/index.txt b/index.txt index 7fe9f0b..96d56eb 100644 --- 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 +`__ 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 + `__ as closely as + reasonable. ++ All code should preferably follow Django's `coding conventions + `__ as well. + + +Django Conventions ================================= .. toctree:: :maxdepth: 2 - coding_conventions + distribution apps/index projects/index diff --git a/projects/index.txt b/projects/index.txt index 1a095bb..510aebf 100644 --- 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 index 388f681..6a5aad6 100644 --- 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/ - `