1280461Sdim# -*- coding: utf-8 -*- 2280461Sdim# 3280461Sdim# lld documentation build configuration file. 4280461Sdim# 5280461Sdim# This file is execfile()d with the current directory set to its containing dir. 6280461Sdim# 7280461Sdim# Note that not all possible configuration values are present in this 8280461Sdim# autogenerated file. 9280461Sdim# 10280461Sdim# All configuration values have a default; values that are commented out 11280461Sdim# serve to show the default. 12280461Sdim 13280461Sdimimport sys, os 14303239Sdimfrom datetime import date 15280461Sdim 16280461Sdim# If extensions (or modules to document with autodoc) are in another directory, 17280461Sdim# add these directories to sys.path here. If the directory is relative to the 18280461Sdim# documentation root, use os.path.abspath to make it absolute, like shown here. 19280461Sdim#sys.path.insert(0, os.path.abspath('.')) 20280461Sdim 21280461Sdim# -- General configuration ----------------------------------------------------- 22280461Sdim 23280461Sdim# If your documentation needs a minimal Sphinx version, state it here. 24280461Sdim#needs_sphinx = '1.0' 25280461Sdim 26280461Sdim# Add any Sphinx extension module names here, as strings. They can be extensions 27280461Sdim# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28280461Sdimextensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo'] 29280461Sdim 30280461Sdim# Add any paths that contain templates here, relative to this directory. 31280461Sdimtemplates_path = ['_templates'] 32280461Sdim 33280461Sdim# The suffix of source filenames. 34280461Sdimsource_suffix = '.rst' 35280461Sdim 36280461Sdim# The encoding of source files. 37280461Sdim#source_encoding = 'utf-8-sig' 38280461Sdim 39280461Sdim# The master toctree document. 40280461Sdimmaster_doc = 'index' 41280461Sdim 42280461Sdim# General information about the project. 43280461Sdimproject = u'lld' 44303239Sdimcopyright = u'2011-%d, LLVM Project' % date.today().year 45280461Sdim 46280461Sdim# The version info for the project you're documenting, acts as replacement for 47280461Sdim# |version| and |release|, also used in various other places throughout the 48280461Sdim# built documents. 49280461Sdim# 50317025Sdim# The short version. 51360784Sdimversion = '10' 52280461Sdim# The full version, including alpha/beta/rc tags. 53360784Sdimrelease = '10' 54280461Sdim 55280461Sdim# The language for content autogenerated by Sphinx. Refer to documentation 56280461Sdim# for a list of supported languages. 57280461Sdim#language = None 58280461Sdim 59280461Sdim# There are two options for replacing |today|: either, you set today to some 60280461Sdim# non-false value, then it is used: 61280461Sdim#today = '' 62280461Sdim# Else, today_fmt is used as the format for a strftime call. 63280461Sdimtoday_fmt = '%Y-%m-%d' 64280461Sdim 65280461Sdim# List of patterns, relative to source directory, that match files and 66280461Sdim# directories to ignore when looking for source files. 67280461Sdimexclude_patterns = ['_build'] 68280461Sdim 69280461Sdim# The reST default role (used for this markup: `text`) to use for all documents. 70280461Sdim#default_role = None 71280461Sdim 72280461Sdim# If true, '()' will be appended to :func: etc. cross-reference text. 73280461Sdim#add_function_parentheses = True 74280461Sdim 75280461Sdim# If true, the current module name will be prepended to all description 76280461Sdim# unit titles (such as .. function::). 77280461Sdim#add_module_names = True 78280461Sdim 79280461Sdim# If true, sectionauthor and moduleauthor directives will be shown in the 80280461Sdim# output. They are ignored by default. 81280461Sdimshow_authors = True 82280461Sdim 83280461Sdim# The name of the Pygments (syntax highlighting) style to use. 84280461Sdimpygments_style = 'friendly' 85280461Sdim 86280461Sdim# A list of ignored prefixes for module index sorting. 87280461Sdim#modindex_common_prefix = [] 88280461Sdim 89280461Sdim 90280461Sdim# -- Options for HTML output --------------------------------------------------- 91280461Sdim 92280461Sdim# The theme to use for HTML and HTML Help pages. See the documentation for 93280461Sdim# a list of builtin themes. 94280461Sdimhtml_theme = 'llvm-theme' 95280461Sdim 96280461Sdim# Theme options are theme-specific and customize the look and feel of a theme 97280461Sdim# further. For a list of options available for each theme, see the 98280461Sdim# documentation. 99280461Sdim#html_theme_options = {} 100280461Sdim 101280461Sdim# Add any paths that contain custom themes here, relative to this directory. 102280461Sdimhtml_theme_path = ["."] 103280461Sdim 104280461Sdim# The name for this set of Sphinx documents. If None, it defaults to 105280461Sdim# "<project> v<release> documentation". 106280461Sdim#html_title = None 107280461Sdim 108280461Sdim# A shorter title for the navigation bar. Default is the same as html_title. 109280461Sdim#html_short_title = None 110280461Sdim 111280461Sdim# The name of an image file (relative to this directory) to place at the top 112280461Sdim# of the sidebar. 113280461Sdim#html_logo = None 114280461Sdim 115280461Sdim# If given, this must be the name of an image file (path relative to the 116280461Sdim# configuration directory) that is the favicon of the docs. Modern browsers use 117280461Sdim# this as icon for tabs, windows and bookmarks. It should be a Windows-style 118280461Sdim# icon file (.ico), which is 16x16 or 32x32 pixels large. Default: None. The 119280461Sdim# image file will be copied to the _static directory of the output HTML, but 120280461Sdim# only if the file does not already exist there. 121280461Sdimhtml_favicon = '_static/favicon.ico' 122280461Sdim 123280461Sdim# Add any paths that contain custom static files (such as style sheets) here, 124280461Sdim# relative to this directory. They are copied after the builtin static files, 125280461Sdim# so a file named "default.css" will overwrite the builtin "default.css". 126280461Sdimhtml_static_path = ['_static'] 127280461Sdim 128280461Sdim# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 129280461Sdim# using the given strftime format. 130280461Sdimhtml_last_updated_fmt = '%Y-%m-%d' 131280461Sdim 132280461Sdim# If true, SmartyPants will be used to convert quotes and dashes to 133280461Sdim# typographically correct entities. 134280461Sdim#html_use_smartypants = True 135280461Sdim 136280461Sdim# Custom sidebar templates, maps document names to template names. 137280461Sdimhtml_sidebars = {'index': 'indexsidebar.html'} 138280461Sdim 139280461Sdim# Additional templates that should be rendered to pages, maps page names to 140280461Sdim# template names. 141280461Sdim# html_additional_pages = {'index': 'index.html'} 142280461Sdim 143280461Sdim# If false, no module index is generated. 144280461Sdim#html_domain_indices = True 145280461Sdim 146280461Sdim# If false, no index is generated. 147280461Sdim#html_use_index = True 148280461Sdim 149280461Sdim# If true, the index is split into individual pages for each letter. 150280461Sdim#html_split_index = False 151280461Sdim 152280461Sdim# If true, links to the reST sources are added to the pages. 153280461Sdimhtml_show_sourcelink = True 154280461Sdim 155280461Sdim# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 156280461Sdim#html_show_sphinx = True 157280461Sdim 158280461Sdim# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 159280461Sdim#html_show_copyright = True 160280461Sdim 161280461Sdim# If true, an OpenSearch description file will be output, and all pages will 162280461Sdim# contain a <link> tag referring to it. The value of this option must be the 163280461Sdim# base URL from which the finished HTML is served. 164280461Sdim#html_use_opensearch = '' 165280461Sdim 166280461Sdim# This is the file name suffix for HTML files (e.g. ".xhtml"). 167280461Sdim#html_file_suffix = None 168280461Sdim 169280461Sdim# Output file base name for HTML help builder. 170280461Sdimhtmlhelp_basename = 'llddoc' 171280461Sdim 172280461Sdim 173280461Sdim# -- Options for LaTeX output -------------------------------------------------- 174280461Sdim 175280461Sdimlatex_elements = { 176280461Sdim# The paper size ('letterpaper' or 'a4paper'). 177280461Sdim#'papersize': 'letterpaper', 178280461Sdim 179280461Sdim# The font size ('10pt', '11pt' or '12pt'). 180280461Sdim#'pointsize': '10pt', 181280461Sdim 182280461Sdim# Additional stuff for the LaTeX preamble. 183280461Sdim#'preamble': '', 184280461Sdim} 185280461Sdim 186280461Sdim# Grouping the document tree into LaTeX files. List of tuples 187280461Sdim# (source start file, target name, title, author, documentclass [howto/manual]). 188280461Sdimlatex_documents = [ 189280461Sdim ('contents', 'lld.tex', u'lld Documentation', 190280461Sdim u'LLVM project', 'manual'), 191280461Sdim] 192280461Sdim 193280461Sdim# The name of an image file (relative to this directory) to place at the top of 194280461Sdim# the title page. 195280461Sdim#latex_logo = None 196280461Sdim 197280461Sdim# For "manual" documents, if this is true, then toplevel headings are parts, 198280461Sdim# not chapters. 199280461Sdim#latex_use_parts = False 200280461Sdim 201280461Sdim# If true, show page references after internal links. 202280461Sdim#latex_show_pagerefs = False 203280461Sdim 204280461Sdim# If true, show URL addresses after external links. 205280461Sdim#latex_show_urls = False 206280461Sdim 207280461Sdim# Documents to append as an appendix to all manuals. 208280461Sdim#latex_appendices = [] 209280461Sdim 210280461Sdim# If false, no module index is generated. 211280461Sdim#latex_domain_indices = True 212280461Sdim 213280461Sdim 214280461Sdim# -- Options for manual page output -------------------------------------------- 215280461Sdim 216280461Sdim# One entry per manual page. List of tuples 217280461Sdim# (source start file, name, description, authors, manual section). 218280461Sdimman_pages = [ 219280461Sdim ('contents', 'lld', u'lld Documentation', 220280461Sdim [u'LLVM project'], 1) 221280461Sdim] 222280461Sdim 223280461Sdim# If true, show URL addresses after external links. 224280461Sdim#man_show_urls = False 225280461Sdim 226280461Sdim 227280461Sdim# -- Options for Texinfo output ------------------------------------------------ 228280461Sdim 229280461Sdim# Grouping the document tree into Texinfo files. List of tuples 230280461Sdim# (source start file, target name, title, author, 231280461Sdim# dir menu entry, description, category) 232280461Sdimtexinfo_documents = [ 233280461Sdim ('contents', 'lld', u'lld Documentation', 234280461Sdim u'LLVM project', 'lld', 'One line description of project.', 235280461Sdim 'Miscellaneous'), 236280461Sdim] 237280461Sdim 238280461Sdim# Documents to append as an appendix to all manuals. 239280461Sdim#texinfo_appendices = [] 240280461Sdim 241280461Sdim# If false, no module index is generated. 242280461Sdim#texinfo_domain_indices = True 243280461Sdim 244280461Sdim# How to display URL addresses: 'footnote', 'no', or 'inline'. 245280461Sdim#texinfo_show_urls = 'footnote' 246280461Sdim 247280461Sdim 248360784Sdim# FIXME: Define intersphinx configuration. 249280461Sdimintersphinx_mapping = {} 250280461Sdim 251280461Sdim 252280461Sdim# -- Options for extensions ---------------------------------------------------- 253280461Sdim 254280461Sdim# Enable this if you want TODOs to show up in the generated documentation. 255280461Sdimtodo_include_todos = True 256