1 # -*- coding: utf-8 -*-
3 # fio documentation build configuration file, created by
4 # sphinx-quickstart on Mon Nov 14 13:56:30 2016.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
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.
21 # sys.path.insert(0, os.path.abspath('.'))
23 # -- General configuration ------------------------------------------------
25 from __future__ import absolute_import
26 from __future__ import print_function
28 # If your documentation needs a minimal Sphinx version, state it here.
30 # needs_sphinx = '1.0'
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['_templates']
40 # The suffix(es) of source filenames.
41 # You can specify multiple suffix as a list of string:
43 # source_suffix = ['.rst', '.md']
44 source_suffix = '.rst'
46 # The encoding of source files.
48 # source_encoding = 'utf-8-sig'
50 # The master toctree document.
53 # General information about the project.
55 copyright = '2017, Jens Axboe <axboe@kernel.dk>'
56 author = 'Jens Axboe <axboe@kernel.dk>'
58 # The version info for the project you're documenting, acts as replacement for
59 # |version| and |release|, also used in various other places throughout the
63 # The short X.Y version.
65 # The full version, including alpha/beta/rc tags.
70 from os.path import exists, dirname, join
71 wsroot = dirname(dirname(__file__))
72 version_file = join(wsroot, "FIO-VERSION-FILE")
73 if not exists(version_file):
74 version_gen = join(wsroot, "FIO-VERSION-GEN")
75 from subprocess import call
76 rc = call(version_gen, shell=True, cwd=wsroot)
78 print("Couldn't generate version file. rc=%r" % rc)
79 return "Unknown", "Unknown"
81 vsl = open(version_file).read().strip().split('-')
83 release = '-'.join(vsl[1:])
84 return version, release
86 version, release = fio_version()
88 # There are two options for replacing |today|: either, you set today to some
89 # non-false value, then it is used:
93 # Else, today_fmt is used as the format for a strftime call.
95 # today_fmt = '%B %d, %Y'
97 # List of patterns, relative to source directory, that match files and
98 # directories to ignore when looking for source files.
99 # This patterns also effect to html_static_path and html_extra_path
100 exclude_patterns = ['output', 'Thumbs.db', '.DS_Store', 'fio_examples.rst']
102 # The reST default role (used for this markup: `text`) to use for all
105 # default_role = None
107 # If true, '()' will be appended to :func: etc. cross-reference text.
109 # add_function_parentheses = True
111 # If true, the current module name will be prepended to all description
112 # unit titles (such as .. function::).
114 # add_module_names = True
116 # If true, sectionauthor and moduleauthor directives will be shown in the
117 # output. They are ignored by default.
119 # show_authors = False
121 # The name of the Pygments (syntax highlighting) style to use.
122 pygments_style = 'sphinx'
124 # A list of ignored prefixes for module index sorting.
125 # modindex_common_prefix = []
127 # If true, keep warnings as "system message" paragraphs in the built documents.
128 # keep_warnings = False
130 # If true, `todo` and `todoList` produce output, else they produce nothing.
131 todo_include_todos = False
134 # -- Options for HTML output ----------------------------------------------
136 # The theme to use for HTML and HTML Help pages. See the documentation for
137 # a list of builtin themes.
139 html_theme = 'alabaster'
141 # Theme options are theme-specific and customize the look and feel of a theme
142 # further. For a list of options available for each theme, see the
145 # html_theme_options = {}
147 # Add any paths that contain custom themes here, relative to this directory.
148 # html_theme_path = []
150 # The name for this set of Sphinx documents.
151 # "<project> v<release> documentation" by default.
153 # html_title = 'fio v1'
155 # A shorter title for the navigation bar. Default is the same as html_title.
157 # html_short_title = None
159 # The name of an image file (relative to this directory) to place at the top
164 # The name of an image file (relative to this directory) to use as a favicon of
165 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
168 # html_favicon = None
170 # Add any paths that contain custom static files (such as style sheets) here,
171 # relative to this directory. They are copied after the builtin static files,
172 # so a file named "default.css" will overwrite the builtin "default.css".
173 # html_static_path = ['_static']
175 # Add any extra paths that contain custom files (such as robots.txt or
176 # .htaccess) here, relative to this directory. These files are copied
177 # directly to the root of the documentation.
179 # html_extra_path = []
181 # If not None, a 'Last updated on:' timestamp is inserted at every page
182 # bottom, using the given strftime format.
183 # The empty string is equivalent to '%b %d, %Y'.
185 # html_last_updated_fmt = None
187 # If true, SmartyPants will be used to convert quotes and dashes to
188 # typographically correct entities.
190 # html_use_smartypants = True
192 # Custom sidebar templates, maps document names to template names.
196 # Additional templates that should be rendered to pages, maps page names to
199 # html_additional_pages = {}
201 # If false, no module index is generated.
203 # html_domain_indices = True
205 # If false, no index is generated.
207 # html_use_index = True
209 # If true, the index is split into individual pages for each letter.
211 # html_split_index = False
213 # If true, links to the reST sources are added to the pages.
215 # html_show_sourcelink = True
217 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
219 # html_show_sphinx = True
221 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
223 # html_show_copyright = True
225 # If true, an OpenSearch description file will be output, and all pages will
226 # contain a <link> tag referring to it. The value of this option must be the
227 # base URL from which the finished HTML is served.
229 # html_use_opensearch = ''
231 # This is the file name suffix for HTML files (e.g. ".xhtml").
232 # html_file_suffix = None
234 # Language to be used for generating the HTML full-text search index.
235 # Sphinx supports the following languages:
236 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
237 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
239 # html_search_language = 'en'
241 # A dictionary with options for the search language support, empty by default.
242 # 'ja' uses this config value.
243 # 'zh' user can custom change `jieba` dictionary path.
245 # html_search_options = {'type': 'default'}
247 # The name of a javascript file (relative to the configuration directory) that
248 # implements a search results scorer. If empty, the default will be used.
250 # html_search_scorer = 'scorer.js'
252 # Output file base name for HTML help builder.
253 htmlhelp_basename = 'fiodoc'
255 # -- Options for LaTeX output ---------------------------------------------
258 # The paper size ('letterpaper' or 'a4paper').
260 # 'papersize': 'letterpaper',
262 # The font size ('10pt', '11pt' or '12pt').
264 # 'pointsize': '10pt',
266 # Additional stuff for the LaTeX preamble.
270 # Latex figure (float) alignment
272 # 'figure_align': 'htbp',
275 # Grouping the document tree into LaTeX files. List of tuples
276 # (source start file, target name, title,
277 # author, documentclass [howto, manual, or own class]).
279 (master_doc, 'fio.tex', 'fio Documentation',
283 # The name of an image file (relative to this directory) to place at the top of
288 # For "manual" documents, if this is true, then toplevel headings are parts,
291 # latex_use_parts = False
293 # If true, show page references after internal links.
295 # latex_show_pagerefs = False
297 # If true, show URL addresses after external links.
299 # latex_show_urls = False
301 # Documents to append as an appendix to all manuals.
303 # latex_appendices = []
305 # It false, will not define \strong, \code, itleref, \crossref ... but only
306 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
309 # latex_keep_old_macro_names = True
311 # If false, no module index is generated.
313 # latex_domain_indices = True
316 # -- Options for manual page output ---------------------------------------
318 # One entry per manual page. List of tuples
319 # (source start file, name, description, authors, manual section).
321 ('fio_man', 'fio', 'flexible I/O tester',
325 # If true, show URL addresses after external links.
327 # man_show_urls = False
330 # -- Options for Texinfo output -------------------------------------------
332 # Grouping the document tree into Texinfo files. List of tuples
333 # (source start file, target name, title, author,
334 # dir menu entry, description, category)
335 texinfo_documents = [
336 (master_doc, 'fio', 'fio Documentation',
337 author, 'fio', 'One line description of project.',
341 # Documents to append as an appendix to all manuals.
343 # texinfo_appendices = []
345 # If false, no module index is generated.
347 # texinfo_domain_indices = True
349 # How to display URL addresses: 'footnote', 'no', or 'inline'.
351 # texinfo_show_urls = 'footnote'
353 # If true, do not generate a @detailmenu in the "Top" node's menu.
355 # texinfo_no_detailmenu = False