Commit | Line | Data |
---|---|---|
6c8200b5 MT |
1 | # -*- coding: utf-8 -*- |
2 | # | |
3 | # fio documentation build configuration file, created by | |
4 | # sphinx-quickstart on Mon Nov 14 13:56:30 2016. | |
5 | # | |
6 | # This file is execfile()d with the current directory set to its | |
7 | # containing dir. | |
8 | # | |
9 | # Note that not all possible configuration values are present in this | |
10 | # autogenerated file. | |
11 | # | |
12 | # All configuration values have a default; values that are commented out | |
13 | # serve to show the default. | |
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 | # | |
19 | # import os | |
20 | # import sys | |
21 | # sys.path.insert(0, os.path.abspath('.')) | |
22 | ||
23 | # -- General configuration ------------------------------------------------ | |
24 | ||
25 | # If your documentation needs a minimal Sphinx version, state it here. | |
26 | # | |
27 | # needs_sphinx = '1.0' | |
28 | ||
29 | # Add any Sphinx extension module names here, as strings. They can be | |
30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
31 | # ones. | |
32 | extensions = [] | |
33 | ||
34 | # Add any paths that contain templates here, relative to this directory. | |
35 | templates_path = ['_templates'] | |
36 | ||
37 | # The suffix(es) of source filenames. | |
38 | # You can specify multiple suffix as a list of string: | |
39 | # | |
40 | # source_suffix = ['.rst', '.md'] | |
41 | source_suffix = '.rst' | |
42 | ||
43 | # The encoding of source files. | |
44 | # | |
45 | # source_encoding = 'utf-8-sig' | |
46 | ||
47 | # The master toctree document. | |
48 | master_doc = 'index' | |
49 | ||
50 | # General information about the project. | |
51 | project = 'fio' | |
f80dba8d | 52 | copyright = '2017, Jens Axboe <axboe@kernel.dk>' |
6c8200b5 MT |
53 | author = 'Jens Axboe <axboe@kernel.dk>' |
54 | ||
55 | # The version info for the project you're documenting, acts as replacement for | |
56 | # |version| and |release|, also used in various other places throughout the | |
57 | # built documents. | |
58 | # | |
f80dba8d | 59 | |
6c8200b5 | 60 | # The short X.Y version. |
f80dba8d | 61 | # version = '1' |
6c8200b5 | 62 | # The full version, including alpha/beta/rc tags. |
f80dba8d MT |
63 | # release = '1' |
64 | ||
65 | def fio_version(): | |
66 | ||
67 | from os.path import exists, dirname, join | |
68 | wsroot = dirname(dirname(__file__)) | |
69 | version_file = join(wsroot, "FIO-VERSION-FILE") | |
70 | if not exists(version_file): | |
71 | version_gen = join(wsroot, "FIO-VERSION-GEN") | |
72 | from subprocess import call | |
73 | rc = call(version_gen, shell=True, cwd=wsroot) | |
74 | if rc: | |
75 | print("Couldn't generate version file. rc=%r" % rc) | |
76 | return "Unknown", "Unknown" | |
77 | ||
78 | vsl = open(version_file).read().strip().split('-') | |
79 | version = vsl[1] | |
80 | release = '-'.join(vsl[1:]) | |
81 | return version, release | |
82 | ||
83 | version, release = fio_version() | |
6c8200b5 MT |
84 | |
85 | # The language for content autogenerated by Sphinx. Refer to documentation | |
86 | # for a list of supported languages. | |
87 | # | |
88 | # This is also used if you do content translation via gettext catalogs. | |
89 | # Usually you set "language" from the command line for these cases. | |
90 | language = None | |
91 | ||
92 | # There are two options for replacing |today|: either, you set today to some | |
93 | # non-false value, then it is used: | |
94 | # | |
95 | # today = '' | |
96 | # | |
97 | # Else, today_fmt is used as the format for a strftime call. | |
98 | # | |
99 | # today_fmt = '%B %d, %Y' | |
100 | ||
101 | # List of patterns, relative to source directory, that match files and | |
102 | # directories to ignore when looking for source files. | |
103 | # This patterns also effect to html_static_path and html_extra_path | |
f80dba8d | 104 | exclude_patterns = ['output', 'Thumbs.db', '.DS_Store', 'fio_examples.rst'] |
6c8200b5 MT |
105 | |
106 | # The reST default role (used for this markup: `text`) to use for all | |
107 | # documents. | |
108 | # | |
109 | # default_role = None | |
110 | ||
111 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
112 | # | |
113 | # add_function_parentheses = True | |
114 | ||
115 | # If true, the current module name will be prepended to all description | |
116 | # unit titles (such as .. function::). | |
117 | # | |
118 | # add_module_names = True | |
119 | ||
120 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
121 | # output. They are ignored by default. | |
122 | # | |
123 | # show_authors = False | |
124 | ||
125 | # The name of the Pygments (syntax highlighting) style to use. | |
126 | pygments_style = 'sphinx' | |
127 | ||
128 | # A list of ignored prefixes for module index sorting. | |
129 | # modindex_common_prefix = [] | |
130 | ||
131 | # If true, keep warnings as "system message" paragraphs in the built documents. | |
132 | # keep_warnings = False | |
133 | ||
134 | # If true, `todo` and `todoList` produce output, else they produce nothing. | |
135 | todo_include_todos = False | |
136 | ||
137 | ||
138 | # -- Options for HTML output ---------------------------------------------- | |
139 | ||
140 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
141 | # a list of builtin themes. | |
142 | # | |
143 | html_theme = 'alabaster' | |
144 | ||
145 | # Theme options are theme-specific and customize the look and feel of a theme | |
146 | # further. For a list of options available for each theme, see the | |
147 | # documentation. | |
148 | # | |
149 | # html_theme_options = {} | |
150 | ||
151 | # Add any paths that contain custom themes here, relative to this directory. | |
152 | # html_theme_path = [] | |
153 | ||
154 | # The name for this set of Sphinx documents. | |
155 | # "<project> v<release> documentation" by default. | |
156 | # | |
157 | # html_title = 'fio v1' | |
158 | ||
159 | # A shorter title for the navigation bar. Default is the same as html_title. | |
160 | # | |
161 | # html_short_title = None | |
162 | ||
163 | # The name of an image file (relative to this directory) to place at the top | |
164 | # of the sidebar. | |
165 | # | |
166 | # html_logo = None | |
167 | ||
168 | # The name of an image file (relative to this directory) to use as a favicon of | |
169 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |
170 | # pixels large. | |
171 | # | |
172 | # html_favicon = None | |
173 | ||
174 | # Add any paths that contain custom static files (such as style sheets) here, | |
175 | # relative to this directory. They are copied after the builtin static files, | |
176 | # so a file named "default.css" will overwrite the builtin "default.css". | |
177 | html_static_path = ['_static'] | |
178 | ||
179 | # Add any extra paths that contain custom files (such as robots.txt or | |
180 | # .htaccess) here, relative to this directory. These files are copied | |
181 | # directly to the root of the documentation. | |
182 | # | |
183 | # html_extra_path = [] | |
184 | ||
185 | # If not None, a 'Last updated on:' timestamp is inserted at every page | |
186 | # bottom, using the given strftime format. | |
187 | # The empty string is equivalent to '%b %d, %Y'. | |
188 | # | |
189 | # html_last_updated_fmt = None | |
190 | ||
191 | # If true, SmartyPants will be used to convert quotes and dashes to | |
192 | # typographically correct entities. | |
193 | # | |
194 | # html_use_smartypants = True | |
195 | ||
196 | # Custom sidebar templates, maps document names to template names. | |
197 | # | |
198 | # html_sidebars = {} | |
199 | ||
200 | # Additional templates that should be rendered to pages, maps page names to | |
201 | # template names. | |
202 | # | |
203 | # html_additional_pages = {} | |
204 | ||
205 | # If false, no module index is generated. | |
206 | # | |
207 | # html_domain_indices = True | |
208 | ||
209 | # If false, no index is generated. | |
210 | # | |
211 | # html_use_index = True | |
212 | ||
213 | # If true, the index is split into individual pages for each letter. | |
214 | # | |
215 | # html_split_index = False | |
216 | ||
217 | # If true, links to the reST sources are added to the pages. | |
218 | # | |
219 | # html_show_sourcelink = True | |
220 | ||
221 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |
222 | # | |
223 | # html_show_sphinx = True | |
224 | ||
225 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |
226 | # | |
227 | # html_show_copyright = True | |
228 | ||
229 | # If true, an OpenSearch description file will be output, and all pages will | |
230 | # contain a <link> tag referring to it. The value of this option must be the | |
231 | # base URL from which the finished HTML is served. | |
232 | # | |
233 | # html_use_opensearch = '' | |
234 | ||
235 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | |
236 | # html_file_suffix = None | |
237 | ||
238 | # Language to be used for generating the HTML full-text search index. | |
239 | # Sphinx supports the following languages: | |
240 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' | |
241 | # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' | |
242 | # | |
243 | # html_search_language = 'en' | |
244 | ||
245 | # A dictionary with options for the search language support, empty by default. | |
246 | # 'ja' uses this config value. | |
247 | # 'zh' user can custom change `jieba` dictionary path. | |
248 | # | |
249 | # html_search_options = {'type': 'default'} | |
250 | ||
251 | # The name of a javascript file (relative to the configuration directory) that | |
252 | # implements a search results scorer. If empty, the default will be used. | |
253 | # | |
254 | # html_search_scorer = 'scorer.js' | |
255 | ||
256 | # Output file base name for HTML help builder. | |
257 | htmlhelp_basename = 'fiodoc' | |
258 | ||
259 | # -- Options for LaTeX output --------------------------------------------- | |
260 | ||
261 | latex_elements = { | |
262 | # The paper size ('letterpaper' or 'a4paper'). | |
263 | # | |
264 | # 'papersize': 'letterpaper', | |
265 | ||
266 | # The font size ('10pt', '11pt' or '12pt'). | |
267 | # | |
268 | # 'pointsize': '10pt', | |
269 | ||
270 | # Additional stuff for the LaTeX preamble. | |
271 | # | |
272 | # 'preamble': '', | |
273 | ||
274 | # Latex figure (float) alignment | |
275 | # | |
276 | # 'figure_align': 'htbp', | |
277 | } | |
278 | ||
279 | # Grouping the document tree into LaTeX files. List of tuples | |
280 | # (source start file, target name, title, | |
281 | # author, documentclass [howto, manual, or own class]). | |
282 | latex_documents = [ | |
283 | (master_doc, 'fio.tex', 'fio Documentation', | |
284 | 'a', 'manual'), | |
285 | ] | |
286 | ||
287 | # The name of an image file (relative to this directory) to place at the top of | |
288 | # the title page. | |
289 | # | |
290 | # latex_logo = None | |
291 | ||
292 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
293 | # not chapters. | |
294 | # | |
295 | # latex_use_parts = False | |
296 | ||
297 | # If true, show page references after internal links. | |
298 | # | |
299 | # latex_show_pagerefs = False | |
300 | ||
301 | # If true, show URL addresses after external links. | |
302 | # | |
303 | # latex_show_urls = False | |
304 | ||
305 | # Documents to append as an appendix to all manuals. | |
306 | # | |
307 | # latex_appendices = [] | |
308 | ||
309 | # It false, will not define \strong, \code, itleref, \crossref ... but only | |
310 | # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added | |
311 | # packages. | |
312 | # | |
313 | # latex_keep_old_macro_names = True | |
314 | ||
315 | # If false, no module index is generated. | |
316 | # | |
317 | # latex_domain_indices = True | |
318 | ||
319 | ||
320 | # -- Options for manual page output --------------------------------------- | |
321 | ||
322 | # One entry per manual page. List of tuples | |
323 | # (source start file, name, description, authors, manual section). | |
324 | man_pages = [ | |
f80dba8d | 325 | ('fio_man', 'fio', 'flexible I/O tester', |
6c8200b5 MT |
326 | [author], 1) |
327 | ] | |
328 | ||
329 | # If true, show URL addresses after external links. | |
330 | # | |
331 | # man_show_urls = False | |
332 | ||
333 | ||
334 | # -- Options for Texinfo output ------------------------------------------- | |
335 | ||
336 | # Grouping the document tree into Texinfo files. List of tuples | |
337 | # (source start file, target name, title, author, | |
338 | # dir menu entry, description, category) | |
339 | texinfo_documents = [ | |
340 | (master_doc, 'fio', 'fio Documentation', | |
341 | author, 'fio', 'One line description of project.', | |
342 | 'Miscellaneous'), | |
343 | ] | |
344 | ||
345 | # Documents to append as an appendix to all manuals. | |
346 | # | |
347 | # texinfo_appendices = [] | |
348 | ||
349 | # If false, no module index is generated. | |
350 | # | |
351 | # texinfo_domain_indices = True | |
352 | ||
353 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | |
354 | # | |
355 | # texinfo_show_urls = 'footnote' | |
356 | ||
357 | # If true, do not generate a @detailmenu in the "Top" node's menu. | |
358 | # | |
359 | # texinfo_no_detailmenu = False |