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