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