1# -*- coding: utf-8 -*- 2# 3# Clang Static Analyzer documentation build configuration file, created by 4# sphinx-quickstart on Wed Jan 2 15:54:28 2013. 5# 6# This file is execfile()d with the current directory set to its containing dir. 7# 8# Note that not all possible configuration values are present in this 9# autogenerated file. 10# 11# All configuration values have a default; values that are commented out 12# serve to show the default. 13 14import sys, os 15from datetime import date 16 17# If extensions (or modules to document with autodoc) are in another directory, 18# add these directories to sys.path here. If the directory is relative to the 19# documentation root, use os.path.abspath to make it absolute, like shown here. 20#sys.path.insert(0, os.path.abspath('.')) 21 22# -- General configuration ----------------------------------------------------- 23 24# If your documentation needs a minimal Sphinx version, state it here. 25#needs_sphinx = '1.0' 26 27# Add any Sphinx extension module names here, as strings. They can be extensions 28# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 29extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax'] 30 31# Add any paths that contain templates here, relative to this directory. 32templates_path = ['_templates'] 33 34# The suffix of source filenames. 35source_suffix = '.rst' 36 37# The encoding of source files. 38#source_encoding = 'utf-8-sig' 39 40# The master toctree document. 41master_doc = 'index' 42 43# General information about the project. 44project = u'Clang Static Analyzer' 45copyright = u'2013-%d, Analyzer Team' % date.today().year 46 47# The version info for the project you're documenting, acts as replacement for 48# |version| and |release|, also used in various other places throughout the 49# built documents. 50# 51# The short version. 52version = '16' 53# The full version, including alpha/beta/rc tags. 54release = '16' 55 56# The language for content autogenerated by Sphinx. Refer to documentation 57# for a list of supported languages. 58#language = None 59 60# There are two options for replacing |today|: either, you set today to some 61# non-false value, then it is used: 62#today = '' 63# Else, today_fmt is used as the format for a strftime call. 64#today_fmt = '%B %d, %Y' 65 66# List of patterns, relative to source directory, that match files and 67# directories to ignore when looking for source files. 68exclude_patterns = ['_build'] 69 70# The reST default role (used for this markup: `text`) to use for all documents. 71#default_role = None 72 73# If true, '()' will be appended to :func: etc. cross-reference text. 74#add_function_parentheses = True 75 76# If true, the current module name will be prepended to all description 77# unit titles (such as .. function::). 78#add_module_names = True 79 80# If true, sectionauthor and moduleauthor directives will be shown in the 81# output. They are ignored by default. 82#show_authors = False 83 84# The name of the Pygments (syntax highlighting) style to use. 85pygments_style = 'sphinx' 86 87 88# -- Options for HTML output --------------------------------------------------- 89 90# The theme to use for HTML and HTML Help pages. See the documentation for 91# a list of builtin themes. 92html_theme = 'haiku' 93 94# Theme options are theme-specific and customize the look and feel of a theme 95# further. For a list of options available for each theme, see the 96# documentation. 97#html_theme_options = {} 98 99# Add any paths that contain custom themes here, relative to this directory. 100#html_theme_path = [] 101 102# The name for this set of Sphinx documents. If None, it defaults to 103# "<project> v<release> documentation". 104#html_title = None 105 106# A shorter title for the navigation bar. Default is the same as html_title. 107#html_short_title = None 108 109# The name of an image file (relative to this directory) to place at the top 110# of the sidebar. 111#html_logo = None 112 113# The name of an image file (within the static path) to use as favicon of the 114# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 115# pixels large. 116#html_favicon = None 117 118# Add any paths that contain custom static files (such as style sheets) here, 119# relative to this directory. They are copied after the builtin static files, 120# so a file named "default.css" will overwrite the builtin "default.css". 121html_static_path = [] 122 123# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 124# using the given strftime format. 125#html_last_updated_fmt = '%b %d, %Y' 126 127# If true, SmartyPants will be used to convert quotes and dashes to 128# typographically correct entities. 129#html_use_smartypants = True 130 131# Custom sidebar templates, maps document names to template names. 132#html_sidebars = {} 133 134# Additional templates that should be rendered to pages, maps page names to 135# template names. 136#html_additional_pages = {} 137 138# If false, no module index is generated. 139#html_domain_indices = True 140 141# If false, no index is generated. 142#html_use_index = True 143 144# If true, the index is split into individual pages for each letter. 145#html_split_index = False 146 147# If true, links to the reST sources are added to the pages. 148#html_show_sourcelink = True 149 150# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 151#html_show_sphinx = True 152 153# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 154#html_show_copyright = True 155 156# If true, an OpenSearch description file will be output, and all pages will 157# contain a <link> tag referring to it. The value of this option must be the 158# base URL from which the finished HTML is served. 159#html_use_opensearch = '' 160 161# This is the file name suffix for HTML files (e.g. ".xhtml"). 162#html_file_suffix = None 163 164# Output file base name for HTML help builder. 165htmlhelp_basename = 'ClangStaticAnalyzerdoc' 166 167 168# -- Options for LaTeX output -------------------------------------------------- 169 170latex_elements = { 171# The paper size ('letterpaper' or 'a4paper'). 172#'papersize': 'letterpaper', 173 174# The font size ('10pt', '11pt' or '12pt'). 175#'pointsize': '10pt', 176 177# Additional stuff for the LaTeX preamble. 178#'preamble': '', 179} 180 181# Grouping the document tree into LaTeX files. List of tuples 182# (source start file, target name, title, author, documentclass [howto/manual]). 183latex_documents = [ 184 ('index', 'ClangStaticAnalyzer.tex', u'Clang Static Analyzer Documentation', 185 u'Analyzer Team', 'manual'), 186] 187 188# The name of an image file (relative to this directory) to place at the top of 189# the title page. 190#latex_logo = None 191 192# For "manual" documents, if this is true, then toplevel headings are parts, 193# not chapters. 194#latex_use_parts = False 195 196# If true, show page references after internal links. 197#latex_show_pagerefs = False 198 199# If true, show URL addresses after external links. 200#latex_show_urls = False 201 202# Documents to append as an appendix to all manuals. 203#latex_appendices = [] 204 205# If false, no module index is generated. 206#latex_domain_indices = True 207 208 209# -- Options for manual page output -------------------------------------------- 210 211# One entry per manual page. List of tuples 212# (source start file, name, description, authors, manual section). 213man_pages = [ 214 ('index', 'clangstaticanalyzer', u'Clang Static Analyzer Documentation', 215 [u'Analyzer Team'], 1) 216] 217 218# If true, show URL addresses after external links. 219#man_show_urls = False 220 221 222# -- Options for Texinfo output ------------------------------------------------ 223 224# Grouping the document tree into Texinfo files. List of tuples 225# (source start file, target name, title, author, 226# dir menu entry, description, category) 227texinfo_documents = [ 228 ('index', 'ClangStaticAnalyzer', u'Clang Static Analyzer Documentation', 229 u'Analyzer Team', 'ClangStaticAnalyzer', 'One line description of project.', 230 'Miscellaneous'), 231] 232 233# Documents to append as an appendix to all manuals. 234#texinfo_appendices = [] 235 236# If false, no module index is generated. 237#texinfo_domain_indices = True 238 239# How to display URL addresses: 'footnote', 'no', or 'inline'. 240#texinfo_show_urls = 'footnote' 241 242 243# Example configuration for intersphinx: refer to the Python standard library. 244intersphinx_mapping = {'http://docs.python.org/': None} 245