[svn] moved some of the documentation into docstrings
--HG--
branch : trunk
diff --git a/docs/generate.py b/docs/generate.py
index a6dbb4e..9ae42f4 100755
--- a/docs/generate.py
+++ b/docs/generate.py
@@ -101,6 +101,13 @@
return '\n\n'.join(result)
+def generate_environment_doc():
+ from jinja.environment import Environment
+ return '%s\n\n%s' % (
+ inspect.getdoc(Environment),
+ inspect.getdoc(Environment.__init__)
+ )
+
e = Environment()
PYGMENTS_FORMATTER = HtmlFormatter(style='pastie', cssclass='syntax')
@@ -108,6 +115,7 @@
LIST_OF_FILTERS = generate_list_of_filters()
LIST_OF_TESTS = generate_list_of_tests()
LIST_OF_LOADERS = generate_list_of_loaders()
+ENVIRONMENT_DOC = generate_environment_doc()
FULL_TEMPLATE = e.from_string('''\
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
@@ -229,7 +237,8 @@
writer = DocumentationWriter(link_style)
data = data.replace('[[list_of_filters]]', LIST_OF_FILTERS)\
.replace('[[list_of_tests]]', LIST_OF_TESTS)\
- .replace('[[list_of_loaders]]', LIST_OF_LOADERS)
+ .replace('[[list_of_loaders]]', LIST_OF_LOADERS)\
+ .replace('[[environment_doc]]', ENVIRONMENT_DOC)
parts = publish_parts(
data,
writer=writer,