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