docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Jinja2 documentation build configuration file, created by
   4 # sphinx-quickstart on Sun Apr 27 21:42:41 2008.
   5 #
   6 # This file is execfile()d with the current directory set to its containing dir.
   7 #
   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).
  10 #
  11 # All configuration values have a default value; values that are commented out
  12 # serve to show the default value.
  13
  14 import sys, os
  15
  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__)))
  20
  21 # General configuration
  22 # ---------------------
  23
  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']
  27
  28 # Add any paths that contain templates here, relative to this directory.
  29 templates_path = ['_templates']
  30
  31 # The suffix of source filenames.
  32 source_suffix = '.rst'
  33
  34 # The master toctree document.
  35 master_doc = 'index'
  36
  37 # General substitutions.
  38 project = 'Jinja2'
  39 copyright = '2008, Armin Ronacher'
  40
  41 # The default replacements for |version| and |release|, also used in various
  42 # other places throughout the built documents.
  43 #
  44 # The short X.Y version.
  45 version = '2.0'
  46 # The full version, including alpha/beta/rc tags.
  47 release = '2.0'
  48
  49 # There are two options for replacing |today|: either, you set today to some
  50 # non-false value, then it is used:
  51 #today = ''
  52 # Else, today_fmt is used as the format for a strftime call.
  53 today_fmt = '%B %d, %Y'
  54
  55 # List of documents that shouldn't be included in the build.
  56 #unused_docs = []
  57
  58 # If true, '()' will be appended to :func: etc. cross-reference text.
  59 #add_function_parentheses = True
  60
  61 # If true, the current module name will be prepended to all description
  62 # unit titles (such as .. function::).
  63 #add_module_names = True
  64
  65 # If true, sectionauthor and moduleauthor directives will be shown in the
  66 # output. They are ignored by default.
  67 #show_authors = False
  68
  69 # The name of the Pygments (syntax highlighting) style to use.
  70 pygments_style = 'jinjaext.JinjaStyle'
  71
  72
  73 # Options for HTML output
  74 # -----------------------
  75
  76 html_theme = 'jinja'
  77 html_theme_path = ['_themes']
  78
  79 # The name for this set of Sphinx documents.  If None, it defaults to
  80 # "<project> v<release> documentation".
  81 #html_title = None
  82
  83 # Add any paths that contain custom static files (such as style sheets) here,
  84 # relative to this directory. They are copied after the builtin static files,
  85 # so a file named "default.css" will overwrite the builtin "default.css".
  86 html_static_path = ['_static']
  87
  88 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  89 # using the given strftime format.
  90 html_last_updated_fmt = '%b %d, %Y'
  91
  92 # If true, SmartyPants will be used to convert quotes and dashes to
  93 # typographically correct entities.
  94 #html_use_smartypants = True
  95
  96 # no modindex
  97 html_use_modindex = False
  98
  99 # If true, the reST sources are included in the HTML build as _sources/<name>.
 100 #html_copy_source = True
 101
 102 # If true, an OpenSearch description file will be output, and all pages will
 103 # contain a <link> tag referring to it.
 104 #html_use_opensearch = False
 105
 106 # Output file base name for HTML help builder.
 107 htmlhelp_basename = 'Jinja2doc'
 108
 109
 110 # Options for LaTeX output
 111 # ------------------------
 112
 113 # The paper size ('letter' or 'a4').
 114 latex_paper_size = 'a4'
 115
 116 # The font size ('10pt', '11pt' or '12pt').
 117 #latex_font_size = '10pt'
 118
 119 # Grouping the document tree into LaTeX files. List of tuples
 120 # (source start file, target name, title, author, document class [howto/manual]).
 121 latex_documents = [
 122   ('index', 'Jinja2.tex', 'Jinja2 Documentation', 'Armin Ronacher', 'manual', 'toctree_only'),
 123 ]
 124
 125 # Additional stuff for the LaTeX preamble.
 126 latex_preamble = '''
 127 \usepackage{palatino}
 128 \definecolor{TitleColor}{rgb}{0.7,0,0}
 129 \definecolor{InnerLinkColor}{rgb}{0.7,0,0}
 130 \definecolor{OuterLinkColor}{rgb}{0.8,0,0}
 131 \definecolor{VerbatimColor}{rgb}{0.985,0.985,0.985}
 132 \definecolor{VerbatimBorderColor}{rgb}{0.8,0.8,0.8}
 133 '''
 134
 135 # Documents to append as an appendix to all manuals.
 136 #latex_appendices = []
 137
 138 # If false, no module index is generated.
 139 latex_use_modindex = False
 140
 141 html_sidebars = {
 142     'index':    ['sidebarlogo.html', 'sidebarintro.html', 'sourcelink.html',
 143                  'searchbox.html'],
 144     '**':       ['sidebarlogo.html', 'localtoc.html', 'relations.html',
 145                  'sourcelink.html', 'searchbox.html']
 146 }