1# -*- coding: utf-8 -*- 2# 3# Mako documentation build configuration file 4# 5# This file is execfile()d with the current directory set to its containing dir. 6# 7# Note that not all possible configuration values are present in this 8# autogenerated file. 9# 10# All configuration values have a default; values that are commented out 11# serve to show the default. 12 13import sys, os 14 15# If extensions (or modules to document with autodoc) are in another directory, 16# add these directories to sys.path here. If the directory is relative to the 17# documentation root, use os.path.abspath to make it absolute, like shown here. 18sys.path.insert(0, os.path.abspath('../..')) 19sys.path.insert(0, os.path.abspath('.')) 20 21import mako 22 23# -- General configuration ----------------------------------------------------- 24 25# If your documentation needs a minimal Sphinx version, state it here. 26#needs_sphinx = '1.0' 27 28# Add any Sphinx extension module names here, as strings. They can be extensions 29# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 30#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 31# 'sphinx.ext.doctest', 'builder.builders'] 32 33extensions = ['sphinx.ext.autodoc', 34 'changelog', 'sphinx_paramlinks', 'zzzeeksphinx'] 35 36changelog_render_ticket = "https://github.com/sqlalchemy/mako/issues/%s" 37 38changelog_render_pullreq = { 39 "default": "https://github.com/sqlalchemy/mako/pull/%s", 40 "github": "https://github.com/sqlalchemy/mako/pull/%s", 41} 42 43# Add any paths that contain templates here, relative to this directory. 44templates_path = ['templates'] 45 46nitpicky = True 47 48 49site_base = os.environ.get("RTD_SITE_BASE", "http://www.makotemplates.org") 50site_adapter_template = "docs_adapter.mako" 51site_adapter_py = "docs_adapter.py" 52 53# The suffix of source filenames. 54source_suffix = '.rst' 55 56# The encoding of source files. 57#source_encoding = 'utf-8-sig' 58 59# The master toctree document. 60master_doc = 'index' 61 62# General information about the project. 63project = u'Mako' 64copyright = u'the Mako authors and contributors' 65 66# The version info for the project you're documenting, acts as replacement for 67# |version| and |release|, also used in various other places throughout the 68# built documents. 69# 70# The short X.Y version. 71version = mako.__version__ 72# The full version, including alpha/beta/rc tags. 73release = "1.0.14" 74 75# The language for content autogenerated by Sphinx. Refer to documentation 76# for a list of supported languages. 77#language = None 78 79# There are two options for replacing |today|: either, you set today to some 80# non-false value, then it is used: 81#today = '' 82# Else, today_fmt is used as the format for a strftime call. 83#today_fmt = '%B %d, %Y' 84 85# List of patterns, relative to source directory, that match files and 86# directories to ignore when looking for source files. 87exclude_patterns = ['build'] 88 89# The reST default role (used for this markup: `text`) to use for all documents. 90#default_role = None 91 92# If true, '()' will be appended to :func: etc. cross-reference text. 93#add_function_parentheses = True 94 95# If true, the current module name will be prepended to all description 96# unit titles (such as .. function::). 97#add_module_names = True 98 99# If true, sectionauthor and moduleauthor directives will be shown in the 100# output. They are ignored by default. 101#show_authors = False 102 103# The name of the Pygments (syntax highlighting) style to use. 104pygments_style = 'sphinx' 105 106# A list of ignored prefixes for module index sorting. 107#modindex_common_prefix = [] 108 109 110# -- Options for HTML output --------------------------------------------------- 111 112# The theme to use for HTML and HTML Help pages. See the documentation for 113# a list of builtin themes. 114html_theme = 'zsmako' 115 116# Theme options are theme-specific and customize the look and feel of a theme 117# further. For a list of options available for each theme, see the 118# documentation. 119#html_theme_options = {} 120 121# Add any paths that contain custom themes here, relative to this directory. 122#html_theme_path = [] 123 124# The style sheet to use for HTML and HTML Help pages. A file of that name 125# must exist either in Sphinx' static/ path, or in one of the custom paths 126# given in html_static_path. 127html_style = 'default.css' 128 129# The name for this set of Sphinx documents. If None, it defaults to 130# "<project> v<release> documentation". 131html_title = "%s %s Documentation" % (project, release) 132 133# A shorter title for the navigation bar. Default is the same as html_title. 134#html_short_title = None 135 136# The name of an image file (relative to this directory) to place at the top 137# of the sidebar. 138#html_logo = None 139 140# The name of an image file (within the static path) to use as favicon of the 141# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 142# pixels large. 143#html_favicon = None 144 145# Add any paths that contain custom static files (such as style sheets) here, 146# relative to this directory. They are copied after the builtin static files, 147# so a file named "default.css" will overwrite the builtin "default.css". 148html_static_path = ['static'] 149 150# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 151# using the given strftime format. 152html_last_updated_fmt = '%m/%d/%Y %H:%M:%S' 153 154# If true, SmartyPants will be used to convert quotes and dashes to 155# typographically correct entities. 156#html_use_smartypants = True 157 158# Custom sidebar templates, maps document names to template names. 159#html_sidebars = {} 160 161# Additional templates that should be rendered to pages, maps page names to 162# template names. 163#html_additional_pages = {} 164 165# If false, no module index is generated. 166html_domain_indices = False 167 168# If false, no index is generated. 169#html_use_index = True 170 171# If true, the index is split into individual pages for each letter. 172#html_split_index = False 173 174# If true, the reST sources are included in the HTML build as _sources/<name>. 175#html_copy_source = True 176html_copy_source = False 177 178# If true, links to the reST sources are added to the pages. 179#html_show_sourcelink = True 180html_show_sourcelink = False 181 182# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 183#html_show_sphinx = True 184 185# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 186#html_show_copyright = True 187 188# If true, an OpenSearch description file will be output, and all pages will 189# contain a <link> tag referring to it. The value of this option must be the 190# base URL from which the finished HTML is served. 191#html_use_opensearch = '' 192 193# This is the file name suffix for HTML files (e.g. ".xhtml"). 194#html_file_suffix = None 195 196# Output file base name for HTML help builder. 197htmlhelp_basename = 'Makodoc' 198 199#autoclass_content = 'both' 200 201# -- Options for LaTeX output -------------------------------------------------- 202 203# The paper size ('letter' or 'a4'). 204#latex_paper_size = 'letter' 205 206# The font size ('10pt', '11pt' or '12pt'). 207#latex_font_size = '10pt' 208 209# Grouping the document tree into LaTeX files. List of tuples 210# (source start file, target name, title, author, documentclass [howto/manual]). 211latex_documents = [ 212 ('index', 'mako_%s.tex' % release.replace('.', '_'), u'Mako Documentation', 213 u'Mike Bayer', 'manual'), 214] 215 216# The name of an image file (relative to this directory) to place at the top of 217# the title page. 218#latex_logo = None 219 220# For "manual" documents, if this is true, then toplevel headings are parts, 221# not chapters. 222#latex_use_parts = False 223 224# If true, show page references after internal links. 225#latex_show_pagerefs = False 226 227# If true, show URL addresses after external links. 228#latex_show_urls = False 229 230# Additional stuff for the LaTeX preamble. 231# sets TOC depth to 2. 232latex_preamble = '\setcounter{tocdepth}{3}' 233 234# Documents to append as an appendix to all manuals. 235#latex_appendices = [] 236 237# If false, no module index is generated. 238#latex_domain_indices = True 239 240#latex_elements = { 241# 'papersize': 'letterpaper', 242# 'pointsize': '10pt', 243#} 244 245# -- Options for manual page output -------------------------------------------- 246 247# One entry per manual page. List of tuples 248# (source start file, name, description, authors, manual section). 249man_pages = [ 250 ('index', 'mako', u'Mako Documentation', 251 [u'Mako authors'], 1) 252] 253 254 255# -- Options for Epub output --------------------------------------------------- 256 257# Bibliographic Dublin Core info. 258epub_title = u'Mako' 259epub_author = u'Mako authors' 260epub_publisher = u'Mako authors' 261epub_copyright = u'Mako authors' 262 263# The language of the text. It defaults to the language option 264# or en if the language is not set. 265#epub_language = '' 266 267# The scheme of the identifier. Typical schemes are ISBN or URL. 268#epub_scheme = '' 269 270# The unique identifier of the text. This can be a ISBN number 271# or the project homepage. 272#epub_identifier = '' 273 274# A unique identification for the text. 275#epub_uid = '' 276 277# HTML files that should be inserted before the pages created by sphinx. 278# The format is a list of tuples containing the path and title. 279#epub_pre_files = [] 280 281# HTML files shat should be inserted after the pages created by sphinx. 282# The format is a list of tuples containing the path and title. 283#epub_post_files = [] 284 285# A list of files that should not be packed into the epub file. 286#epub_exclude_files = [] 287 288# The depth of the table of contents in toc.ncx. 289#epub_tocdepth = 3 290 291# Allow duplicate toc entries. 292#epub_tocdup = True 293 294