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