1 # -*- coding: utf-8 -*-
3 # Jinja2 documentation build configuration file, created by
4 # sphinx-quickstart on Sun Apr 27 21:42:41 2008.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # The contents of this file are pickled, so don't put values in the namespace
9 # that aren't pickleable (module imports are okay, they're removed automatically).
11 # All configuration values have a default value; values that are commented out
12 # serve to show the default value.
16 # If your extensions are in another directory, add it here. If the directory
17 # is relative to the documentation root, use os.path.abspath to make it
18 # absolute, like shown here.
19 sys.path.append(os.path.dirname(os.path.abspath(__file__)))
21 # General configuration
22 # ---------------------
24 # Add any Sphinx extension module names here, as strings. They can be extensions
25 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26 extensions = ['sphinx.ext.autodoc', 'jinjaext']
28 # Add any paths that contain templates here, relative to this directory.
29 templates_path = ['_templates']
31 # The suffix of source filenames.
32 source_suffix = '.rst'
34 # The master toctree document.
37 # General substitutions.
39 copyright = '2008, Armin Ronacher'
41 # The default replacements for |version| and |release|, also used in various
42 # other places throughout the built documents.
44 # The short X.Y version.
47 release = pkg_resources.get_distribution('Jinja2').version
49 print 'To build the documentation, The distribution information of Jinja2'
50 print 'Has to be available. Either install the package into your'
51 print 'development environment or run "setup.py develop" to setup the'
52 print 'metadata. A virtualenv is recommended!'
55 release = release.split('dev')[0] + 'dev'
56 version = '.'.join(release.split('.')[:2])
58 # There are two options for replacing |today|: either, you set today to some
59 # non-false value, then it is used:
61 # Else, today_fmt is used as the format for a strftime call.
62 today_fmt = '%B %d, %Y'
64 # List of documents that shouldn't be included in the build.
67 # If true, '()' will be appended to :func: etc. cross-reference text.
68 #add_function_parentheses = True
70 # If true, the current module name will be prepended to all description
71 # unit titles (such as .. function::).
72 #add_module_names = True
74 # If true, sectionauthor and moduleauthor directives will be shown in the
75 # output. They are ignored by default.
78 # The name of the Pygments (syntax highlighting) style to use.
79 pygments_style = 'jinjaext.JinjaStyle'
82 # Options for HTML output
83 # -----------------------
86 html_theme_path = ['_themes']
88 # The name for this set of Sphinx documents. If None, it defaults to
89 # "<project> v<release> documentation".
92 # Add any paths that contain custom static files (such as style sheets) here,
93 # relative to this directory. They are copied after the builtin static files,
94 # so a file named "default.css" will overwrite the builtin "default.css".
95 html_static_path = ['_static']
97 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
98 # using the given strftime format.
99 html_last_updated_fmt = '%b %d, %Y'
101 # If true, SmartyPants will be used to convert quotes and dashes to
102 # typographically correct entities.
103 #html_use_smartypants = True
106 html_use_modindex = False
108 # If true, the reST sources are included in the HTML build as _sources/<name>.
109 #html_copy_source = True
111 # If true, an OpenSearch description file will be output, and all pages will
112 # contain a <link> tag referring to it.
113 #html_use_opensearch = False
115 # Output file base name for HTML help builder.
116 htmlhelp_basename = 'Jinja2doc'
119 # Options for LaTeX output
120 # ------------------------
122 # The paper size ('letter' or 'a4').
123 latex_paper_size = 'a4'
125 # The font size ('10pt', '11pt' or '12pt').
126 #latex_font_size = '10pt'
128 # Grouping the document tree into LaTeX files. List of tuples
129 # (source start file, target name, title, author, document class [howto/manual]).
131 ('latexindex', 'Jinja2.tex', 'Jinja2 Documentation', 'Armin Ronacher',
135 # Additional stuff for LaTeX
137 'fontpkg': r'\usepackage{mathpazo}',
138 'papersize': 'a4paper',
141 \usepackage{jinjastyle}
144 \DeclareUnicodeCharacter{14D}{o}
148 latex_use_parts = True
150 latex_additional_files = ['jinjastyle.sty', 'logo.pdf']
152 # If false, no module index is generated.
153 latex_use_modindex = False
156 'index': ['sidebarlogo.html', 'sidebarintro.html', 'sourcelink.html',
158 '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
159 'sourcelink.html', 'searchbox.html']