From: Armin Ronacher <armin.ronacher@active-4.com>
Date: Mon, 11 Feb 2008 14:36:22 +0000 (+0100)
Subject: moved docstring into setup.py, this fixes #297
X-Git-Tag: 2.0rc1~218^2
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5829306644aa8e62d78efcf553c6434bfe9d5772;p=jinja2.git

moved docstring into setup.py, this fixes #297

--HG--
branch : trunk
---

diff --git a/setup.py b/setup.py
index 712ca82..d2eac94 100644
--- a/setup.py
+++ b/setup.py
@@ -1,5 +1,57 @@
 # -*- coding: utf-8 -*-
-import jinja
+"""
+jinja
+~~~~~
+
+Jinja is a `sandboxed`_ template engine written in pure Python. It
+provides a `Django`_ like non-XML syntax and compiles templates into
+executable python code. It's basically a combination of Django templates
+and python code.
+
+Nutshell
+--------
+
+Here a small example of a Jinja template::
+
+    {% extends 'base.html' %}
+    {% block title %}Memberlist{% endblock %}
+    {% block content %}
+      <ul>
+      {% for user in users %}
+        <li><a href="{{ user.url|e }}">{{ user.username|e }}</a></li>
+      {% endfor %}
+      </ul>
+    {% endblock %}
+
+Philosophy
+----------
+
+Application logic is for the controller but don't try to make the life
+for the template designer too hard by giving him too few functionality.
+
+For more informations visit the new `jinja webpage`_ and `documentation`_.
+
+Note
+----
+
+This is the Jinja 1.0 release which is completely incompatible with the
+old "pre 1.0" branch. The old branch will still receive security updates
+and bugfixes but the 1.0 branch will be the only version that receives
+support.
+
+If you have an application that uses Jinja 0.9 and won't be updated in
+the near future the best idea is to ship a Jinja 0.9 checkout together
+with the application.
+
+The `Jinja tip`_ is installable via `easy_install` with ``easy_install
+Jinja==dev``.
+
+.. _sandboxed: http://en.wikipedia.org/wiki/Sandbox_(computer_security)
+.. _Django: http://www.djangoproject.com/
+.. _jinja webpage: http://jinja.pocoo.org/
+.. _documentation: http://jinja.pocoo.org/documentation/index.html
+.. _Jinja tip: http://dev.pocoo.org/hg/jinja-main/archive/tip.tar.gz#egg=Jinja-dev
+"""
 import os
 import sys
 import ez_setup
@@ -8,7 +60,6 @@ ez_setup.use_setuptools()
 from distutils.command.build_ext import build_ext
 from distutils.errors import CCompilerError, DistutilsError
 from setuptools import setup, Extension, Feature
-from inspect import getdoc
 
 
 def list_files(path):
@@ -61,7 +112,7 @@ setup(
     author_email='armin.ronacher@active-4.com',
     description='A small but fast and easy to use stand-alone template '
                 'engine written in pure python.',
-    long_description = getdoc(jinja),
+    long_description = __doc__,
     # jinja is egg safe. But because we distribute the documentation
     # in form of html and txt files it's a better idea to extract the files
     zip_safe=False,