1 # -*- coding: utf-8 -*-
3 # lld documentation build configuration file.
5 # This file is execfile()d with the current directory set to its containing dir.
7 # Note that not all possible configuration values are present in this
10 # All configuration values have a default; values that are commented out
11 # serve to show the default.
14 from datetime
import date
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 # sys.path.insert(0, os.path.abspath('.'))
21 # -- General configuration -----------------------------------------------------
23 # If your documentation needs a minimal Sphinx version, state it here.
24 # needs_sphinx = '1.0'
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions
= ["sphinx.ext.intersphinx", "sphinx.ext.todo"]
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path
= ["_templates"]
33 # The suffix of source filenames.
34 source_suffix
= ".rst"
36 # The encoding of source files.
37 # source_encoding = 'utf-8-sig'
39 # The master toctree document.
42 # General information about the project.
44 copyright
= "2011-%d, LLVM Project" % date
.today().year
46 # The language for content autogenerated by Sphinx. Refer to documentation
47 # for a list of supported languages.
50 # There are two options for replacing |today|: either, you set today to some
51 # non-false value, then it is used:
53 # Else, today_fmt is used as the format for a strftime call.
54 today_fmt
= "%Y-%m-%d"
56 # List of patterns, relative to source directory, that match files and
57 # directories to ignore when looking for source files.
58 exclude_patterns
= ["_build"]
60 # The reST default role (used for this markup: `text`) to use for all documents.
63 # If true, '()' will be appended to :func: etc. cross-reference text.
64 # add_function_parentheses = True
66 # If true, the current module name will be prepended to all description
67 # unit titles (such as .. function::).
68 # add_module_names = True
70 # If true, sectionauthor and moduleauthor directives will be shown in the
71 # output. They are ignored by default.
74 # The name of the Pygments (syntax highlighting) style to use.
75 pygments_style
= "friendly"
77 # A list of ignored prefixes for module index sorting.
78 # modindex_common_prefix = []
81 # -- Options for HTML output ---------------------------------------------------
83 # The theme to use for HTML and HTML Help pages. See the documentation for
84 # a list of builtin themes.
85 html_theme
= "llvm-theme"
87 # Theme options are theme-specific and customize the look and feel of a theme
88 # further. For a list of options available for each theme, see the
90 # html_theme_options = {}
92 # Add any paths that contain custom themes here, relative to this directory.
93 html_theme_path
= ["."]
95 # The name for this set of Sphinx documents. If None, it defaults to
96 # "<project> v<release> documentation".
99 # A shorter title for the navigation bar. Default is the same as html_title.
100 # html_short_title = None
102 # The name of an image file (relative to this directory) to place at the top
106 # If given, this must be the name of an image file (path relative to the
107 # configuration directory) that is the favicon of the docs. Modern browsers use
108 # this as icon for tabs, windows and bookmarks. It should be a Windows-style
109 # icon file (.ico), which is 16x16 or 32x32 pixels large. Default: None. The
110 # image file will be copied to the _static directory of the output HTML, but
111 # only if the file does not already exist there.
112 html_favicon
= "_static/favicon.ico"
114 # Add any paths that contain custom static files (such as style sheets) here,
115 # relative to this directory. They are copied after the builtin static files,
116 # so a file named "default.css" will overwrite the builtin "default.css".
117 html_static_path
= ["_static"]
119 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
120 # using the given strftime format.
121 html_last_updated_fmt
= "%Y-%m-%d"
123 # If true, SmartyPants will be used to convert quotes and dashes to
124 # typographically correct entities.
125 # html_use_smartypants = True
127 # Custom sidebar templates, maps document names to template names.
128 html_sidebars
= {"index": ["indexsidebar.html"]}
130 # Additional templates that should be rendered to pages, maps page names to
132 # html_additional_pages = {'index': 'index.html'}
134 # If false, no module index is generated.
135 # html_domain_indices = True
137 # If false, no index is generated.
138 # html_use_index = True
140 # If true, the index is split into individual pages for each letter.
141 # html_split_index = False
143 # If true, links to the reST sources are added to the pages.
144 html_show_sourcelink
= True
146 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
147 # html_show_sphinx = True
149 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
150 # html_show_copyright = True
152 # If true, an OpenSearch description file will be output, and all pages will
153 # contain a <link> tag referring to it. The value of this option must be the
154 # base URL from which the finished HTML is served.
155 # html_use_opensearch = ''
157 # This is the file name suffix for HTML files (e.g. ".xhtml").
158 # html_file_suffix = None
160 # Output file base name for HTML help builder.
161 htmlhelp_basename
= "llddoc"
164 # -- Options for LaTeX output --------------------------------------------------
167 # The paper size ('letterpaper' or 'a4paper').
168 #'papersize': 'letterpaper',
169 # The font size ('10pt', '11pt' or '12pt').
170 #'pointsize': '10pt',
171 # Additional stuff for the LaTeX preamble.
175 # Grouping the document tree into LaTeX files. List of tuples
176 # (source start file, target name, title, author, documentclass [howto/manual]).
178 ("contents", "lld.tex", "lld Documentation", "LLVM project", "manual"),
181 # The name of an image file (relative to this directory) to place at the top of
185 # For "manual" documents, if this is true, then toplevel headings are parts,
187 # latex_use_parts = False
189 # If true, show page references after internal links.
190 # latex_show_pagerefs = False
192 # If true, show URL addresses after external links.
193 # latex_show_urls = False
195 # Documents to append as an appendix to all manuals.
196 # latex_appendices = []
198 # If false, no module index is generated.
199 # latex_domain_indices = True
202 # -- Options for manual page output --------------------------------------------
204 # One entry per manual page. List of tuples
205 # (source start file, name, description, authors, manual section).
206 man_pages
= [("contents", "lld", "lld Documentation", ["LLVM project"], 1)]
208 # If true, show URL addresses after external links.
209 # man_show_urls = False
212 # -- Options for Texinfo output ------------------------------------------------
214 # Grouping the document tree into Texinfo files. List of tuples
215 # (source start file, target name, title, author,
216 # dir menu entry, description, category)
217 texinfo_documents
= [
224 "One line description of project.",
229 # Documents to append as an appendix to all manuals.
230 # texinfo_appendices = []
232 # If false, no module index is generated.
233 # texinfo_domain_indices = True
235 # How to display URL addresses: 'footnote', 'no', or 'inline'.
236 # texinfo_show_urls = 'footnote'
239 # FIXME: Define intersphinx configuration.
240 intersphinx_mapping
= {}
243 # -- Options for extensions ----------------------------------------------------
245 # Enable this if you want TODOs to show up in the generated documentation.
246 todo_include_todos
= True