1c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# -*- coding: utf-8 -*- 2c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# 3c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Gallium documentation build configuration file, created by 4c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# sphinx-quickstart on Sun Dec 20 14:09:05 2009. 5c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# 6c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# This file is execfile()d with the current directory set to its containing dir. 7c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# 8c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Note that not all possible configuration values are present in this 9c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# autogenerated file. 10c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# 11c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# All configuration values have a default; values that are commented out 12c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# serve to show the default. 13c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 14c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonimport sys, os 15c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 16c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If extensions (or modules to document with autodoc) are in another directory, 17c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# add these directories to sys.path here. If the directory is relative to the 18c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# documentation root, use os.path.abspath to make it absolute, like shown here. 198580522b14b19e5087a6b72fb694630b962e29baCorbin Simpsonsys.path.append(os.path.abspath('exts')) 20c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 21c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# -- General configuration ----------------------------------------------------- 22c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 23c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Add any Sphinx extension module names here, as strings. They can be extensions 24c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 25bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpsonextensions = ['sphinx.ext.pngmath', 'formatting'] 26c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 27c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Add any paths that contain templates here, relative to this directory. 28c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsontemplates_path = ['_templates'] 29c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 30c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The suffix of source filenames. 31c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonsource_suffix = '.rst' 32c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 33c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The encoding of source files. 34c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#source_encoding = 'utf-8' 35c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 36c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The master toctree document. 37c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonmaster_doc = 'index' 38c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 39c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# General information about the project. 40c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonproject = u'Gallium' 418bae190f18dfa91cd60d91d91169503c3addb11fVinson Leecopyright = u'2009, VMware, X.org, Nouveau' 42c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 43c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The version info for the project you're documenting, acts as replacement for 44c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# |version| and |release|, also used in various other places throughout the 45c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# built documents. 46c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# 47c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The short X.Y version. 48dda8046a6460cbdcfd0ed8a78a443077296a29d2Vinson Leeversion = '0.4' 49c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The full version, including alpha/beta/rc tags. 50dda8046a6460cbdcfd0ed8a78a443077296a29d2Vinson Leerelease = '0.4' 51c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 52c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The language for content autogenerated by Sphinx. Refer to documentation 53c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# for a list of supported languages. 54c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#language = None 55c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 56c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# There are two options for replacing |today|: either, you set today to some 57c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# non-false value, then it is used: 58c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#today = '' 59c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Else, today_fmt is used as the format for a strftime call. 60c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#today_fmt = '%B %d, %Y' 61c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 62c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# List of documents that shouldn't be included in the build. 63c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#unused_docs = [] 64c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 65c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# List of directories, relative to source directory, that shouldn't be searched 66c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# for source files. 67c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonexclude_trees = [] 68c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 69c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The reST default role (used for this markup: `text`) to use for all documents. 70c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#default_role = None 71c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 72c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If true, '()' will be appended to :func: etc. cross-reference text. 73c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#add_function_parentheses = True 74c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 75c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If true, the current module name will be prepended to all description 76c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# unit titles (such as .. function::). 77c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#add_module_names = True 78c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 79c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If true, sectionauthor and moduleauthor directives will be shown in the 80c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# output. They are ignored by default. 81c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#show_authors = False 82c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 83c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The name of the Pygments (syntax highlighting) style to use. 84c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonpygments_style = 'sphinx' 85c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 869ddeab48c85d45b7b7cc781dcf566e0767c84ba5Corbin Simpson# The language for highlighting source code. 879ddeab48c85d45b7b7cc781dcf566e0767c84ba5Corbin Simpsonhighlight_language = 'c' 889ddeab48c85d45b7b7cc781dcf566e0767c84ba5Corbin Simpson 89c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# A list of ignored prefixes for module index sorting. 90c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#modindex_common_prefix = [] 91c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 92c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 93c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# -- Options for HTML output --------------------------------------------------- 94c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 95c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The theme to use for HTML and HTML Help pages. Major themes that come with 96c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Sphinx are currently 'default' and 'sphinxdoc'. 97c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonhtml_theme = 'default' 98c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 99c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Theme options are theme-specific and customize the look and feel of a theme 100c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# further. For a list of options available for each theme, see the 101c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# documentation. 102c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_theme_options = {} 103c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 104c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Add any paths that contain custom themes here, relative to this directory. 105c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_theme_path = [] 106c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 107c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The name for this set of Sphinx documents. If None, it defaults to 108c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# "<project> v<release> documentation". 109c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_title = None 110c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 111c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# A shorter title for the navigation bar. Default is the same as html_title. 112c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_short_title = None 113c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 114c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The name of an image file (relative to this directory) to place at the top 115c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# of the sidebar. 116c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_logo = None 117c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 118c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The name of an image file (within the static path) to use as favicon of the 119c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 120c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# pixels large. 121c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_favicon = None 122c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 123c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Add any paths that contain custom static files (such as style sheets) here, 124c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# relative to this directory. They are copied after the builtin static files, 125c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# so a file named "default.css" will overwrite the builtin "default.css". 126c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonhtml_static_path = ['_static'] 127c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 128c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 129c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# using the given strftime format. 130c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_last_updated_fmt = '%b %d, %Y' 131c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 132c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If true, SmartyPants will be used to convert quotes and dashes to 133c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# typographically correct entities. 134c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_use_smartypants = True 135c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 136c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Custom sidebar templates, maps document names to template names. 137c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_sidebars = {} 138c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 139c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Additional templates that should be rendered to pages, maps page names to 140c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# template names. 141c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_additional_pages = {} 142c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 143c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If false, no module index is generated. 144c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_use_modindex = True 145c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 146c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If false, no index is generated. 147c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_use_index = True 148c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 149c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If true, the index is split into individual pages for each letter. 150c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_split_index = False 151c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 152c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If true, links to the reST sources are added to the pages. 153c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_show_sourcelink = True 154c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 155c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If true, an OpenSearch description file will be output, and all pages will 156c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# contain a <link> tag referring to it. The value of this option must be the 157c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# base URL from which the finished HTML is served. 158c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_use_opensearch = '' 159c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 160c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 161c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#html_file_suffix = '' 162c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 163c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Output file base name for HTML help builder. 164c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonhtmlhelp_basename = 'Galliumdoc' 165c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 166c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 167c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# -- Options for LaTeX output -------------------------------------------------- 168c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 169c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The paper size ('letter' or 'a4'). 170c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#latex_paper_size = 'letter' 171c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 172c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The font size ('10pt', '11pt' or '12pt'). 173c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#latex_font_size = '10pt' 174c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 175c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Grouping the document tree into LaTeX files. List of tuples 176c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# (source start file, target name, title, author, documentclass [howto/manual]). 177c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpsonlatex_documents = [ 178c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson ('index', 'Gallium.tex', u'Gallium Documentation', 1798bae190f18dfa91cd60d91d91169503c3addb11fVinson Lee u'VMware, X.org, Nouveau', 'manual'), 180c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson] 181c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 182c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# The name of an image file (relative to this directory) to place at the top of 183c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# the title page. 184c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#latex_logo = None 185c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 186c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# For "manual" documents, if this is true, then toplevel headings are parts, 187c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# not chapters. 188c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#latex_use_parts = False 189c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 190c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Additional stuff for the LaTeX preamble. 191c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#latex_preamble = '' 192c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 193c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# Documents to append as an appendix to all manuals. 194c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#latex_appendices = [] 195c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson 196c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson# If false, no module index is generated. 197c686e17e52eb9964137fd1a46fbbc96e368b6286Corbin Simpson#latex_use_modindex = True 198