249 lines · python
1# -*- coding: utf-8 -*-2#3# LLDB documentation build configuration file, created by4# sphinx-quickstart on Sun Dec 9 20:01:55 2012.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 this9# autogenerated file.10#11# All configuration values have a default; values that are commented out12# serve to show the default.13 14import sys, os15from datetime import date16 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 the19# 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 extensions28# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.29extensions = ["sphinx.ext.todo", "sphinx.ext.mathjax", "sphinx.ext.intersphinx"]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 = "LLVM/OpenMP"45copyright = "2013-%d, LLVM/OpenMP" % date.today().year46 47# The version info for the project you're documenting, acts as replacement for48# |version| and |release|, also used in various other places throughout the49# built documents. These are currently set to zero because we don't use them.50# Should somebody consider in the future to change them, they need to be updated51# everytime a new release comes out.52#53# The short version.54# version = '0'55# The full version, including alpha/beta/rc tags.56# release = '0'57 58# The language for content autogenerated by Sphinx. Refer to documentation59# for a list of supported languages.60# language = None61 62# There are two options for replacing |today|: either, you set today to some63# non-false value, then it is used:64# today = ''65# Else, today_fmt is used as the format for a strftime call.66# today_fmt = '%B %d, %Y'67 68# List of patterns, relative to source directory, that match files and69# directories to ignore when looking for source files.70exclude_patterns = ["_build", "analyzer"]71 72# The reST default role (used for this markup: `text`) to use for all documents.73# default_role = None74 75# If true, '()' will be appended to :func: etc. cross-reference text.76# add_function_parentheses = True77 78# If true, the current module name will be prepended to all description79# unit titles (such as .. function::).80# add_module_names = True81 82# If true, sectionauthor and moduleauthor directives will be shown in the83# output. They are ignored by default.84show_authors = True85 86# The name of the Pygments (syntax highlighting) style to use.87pygments_style = "friendly"88 89# A list of ignored prefixes for module index sorting.90# modindex_common_prefix = []91 92 93# -- Options for HTML output ---------------------------------------------------94 95# The theme to use for HTML and HTML Help pages. See the documentation for96# a list of builtin themes.97html_theme = "llvm-openmp-theme"98 99# Theme options are theme-specific and customize the look and feel of a theme100# further. For a list of options available for each theme, see the101# documentation.102# html_theme_options = { 'font_size': '11pt' }103 104# Add any paths that contain custom themes here, relative to this directory.105html_theme_path = ["_themes"]106 107# The name for this set of Sphinx documents. If None, it defaults to108# "<project> v<release> documentation".109# html_title = 'OpenMP Parallel Programming API'110 111# A shorter title for the navigation bar. Default is the same as html_title.112# html_short_title = None113 114# The name of an image file (relative to this directory) to place at the top115# of the sidebar.116# html_logo = None117 118# The name of an image file (within the static path) to use as favicon of the119# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32120# pixels large.121# html_favicon = None122 123# Add any paths that contain custom static files (such as style sheets) here,124# relative to this directory. They are copied after the builtin static files,125# so a file named "default.css" will overwrite the builtin "default.css".126html_static_path = ["_static"]127 128# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,129# using the given strftime format.130html_last_updated_fmt = "%Y-%m-%d"131 132# If true, SmartyPants will be used to convert quotes and dashes to133# typographically correct entities.134# html_use_smartypants = True135 136# Custom sidebar templates, maps document names to template names.137# html_sidebars = {}138 139# Additional templates that should be rendered to pages, maps page names to140# template names.141# html_additional_pages = {}142 143# If false, no module index is generated.144# html_domain_indices = True145 146# If false, no index is generated.147# html_use_index = True148 149# If true, the index is split into individual pages for each letter.150# html_split_index = False151 152# If true, links to the reST sources are added to the pages.153# html_show_sourcelink = True154 155# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.156# html_show_sphinx = True157 158# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.159# html_show_copyright = True160 161# If true, an OpenSearch description file will be output, and all pages will162# contain a <link> tag referring to it. The value of this option must be the163# base URL from which the finished HTML is served.164# html_use_opensearch = ''165 166# This is the file name suffix for HTML files (e.g. ".xhtml").167# html_file_suffix = None168 169# Output file base name for HTML help builder.170htmlhelp_basename = "OpenMPdoc"171 172# If true, the reST sources are included in the HTML build as173# _sources/name. The default is True.174html_copy_source = False175 176# -- Options for LaTeX output --------------------------------------------------177 178latex_elements = {179 # The paper size ('letterpaper' or 'a4paper').180 #'papersize': 'letterpaper',181 # The font size ('10pt', '11pt' or '12pt').182 #'pointsize': '10pt',183 # Additional stuff for the LaTeX preamble.184 #'preamble': '',185}186 187# Grouping the document tree into LaTeX files. List of tuples188# (source start file, target name, title, author, documentclass [howto/manual]).189latex_documents = [190 ("index", "OpenMP.tex", "LLVM/OpenMP Documentation", "LLVM/OpenMP", "manual"),191]192 193# The name of an image file (relative to this directory) to place at the top of194# the title page.195# latex_logo = None196 197# For "manual" documents, if this is true, then toplevel headings are parts,198# not chapters.199# latex_use_parts = False200 201# If true, show page references after internal links.202# latex_show_pagerefs = False203 204# If true, show URL addresses after external links.205# latex_show_urls = False206 207# Documents to append as an appendix to all manuals.208# latex_appendices = []209 210# If false, no module index is generated.211# latex_domain_indices = True212 213 214# -- Options for manual page output --------------------------------------------215 216# One entry per manual page. List of tuples217# (source start file, name, description, authors, manual section).218# man_pages = [('man/lldb', 'lldb', u'LLDB Documentation', [u'LLVM project'], 1)]219 220# If true, show URL addresses after external links.221# man_show_urls = False222 223 224# -- Options for Texinfo output ------------------------------------------------225 226# Grouping the document tree into Texinfo files. List of tuples227# (source start file, target name, title, author,228# dir menu entry, description, category)229texinfo_documents = [230 (231 "index",232 "LLVM/OpenMP",233 "LLVM/OpenMP Documentation",234 "LLVM/OpenMP",235 "LLVM/OpenMP",236 "One line description of project.",237 "Miscellaneous",238 ),239]240 241# Documents to append as an appendix to all manuals.242# texinfo_appendices = []243 244# If false, no module index is generated.245# texinfo_domain_indices = True246 247# How to display URL addresses: 'footnote', 'no', or 'inline'.248# texinfo_show_urls = 'footnote'249