- Add includeme function (meant to be used via config.include).

- Fix documentation bug related to ``paster create`` reported at
  https://github.com/Pylons/pyramid_jinja2/issues#issue/12

CHANGES.txt

@@ -1,6 +1,11 @@
 Next release
 ============
 
+- Add ``includeme`` function (meant to be used via ``config.include``).
+
+- Fix documentation bug related to ``paster create`` reported at
+  https://github.com/Pylons/pyramid_jinja2/issues#issue/12
+
 0.4 (2010-12-16)
 ================
 

docs/index.rst

@@ -15,8 +15,13 @@ active.  Both are completely equivalent.
 
     <include package="pyramid_jinja2"/>
 
-#) Call the ``add_renderer`` method of a Configurator in your
-   application during configuration::
+#) Use the ``includeme`` function via ``config.include``::
+
+    import pyramid_jinja2
+    config.include(pyramid_jinja2.includeme)
+
+You can also drive the oxcart by hand instead of either of the above two
+ways::
 
     from pyramid_jinja2 import renderer_factory
     config.add_renderer('.jinja2', renderer_factory)
@@ -168,7 +173,7 @@ Creating a Jinja2 ``Pyramid`` Project
 After you've got ``pyramid_jinja2`` installed, you can invoke the following
 command to create a Jinja2-based Pyramid project::
 
-  $ paster create -t bin/paster pyramid_jinja2_starter
+  $ paster create -t pyramid_jinja2_starter
 
 This is a good way to see a working Pyramid application that uses Jinja2, even
 if you wind up not using the result.

pyramid_jinja2/__init__.py

@@ -103,3 +103,6 @@ def __call__(self, value, system):
         return result
 
 
+def includeme(config):
+    config.add_renderer('.jinja2', renderer_factory)
+

pyramid_jinja2/tests/test_it.py

@@ -249,6 +249,16 @@ def test_render(self):
         result = render('helloworld.jinja2', {'a':1})
         self.assertEqual(result, u'\nHello föö')
 
+class Test_includeme(unittest.TestCase):
+    def test_it(self):
+        from pyramid.interfaces import IRendererFactory
+        from pyramid_jinja2 import includeme
+        from pyramid_jinja2 import renderer_factory
+        config = testing.setUp()
+        includeme(config)
+        utility = config.registry.getUtility(IRendererFactory, name='.jinja2')
+        self.assertEqual(utility, renderer_factory)
+
 class DummyEnvironment(object):
     def get_template(self, path):
         self.path = path