docs/conf.py

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