1
# -*- coding: utf-8 -*-
3
# Linaro JSON documentation build configuration file, created by
4
# sphinx-quickstart on Mon Dec 27 16:39:47 2010.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
17
# If extensions (or modules to document with autodoc) are in another directory,
18
# add these directories to sys.path here. If the directory is relative to the
19
# documentation root, use os.path.abspath to make it absolute, like shown here.
20
sys.path.append(os.path.abspath('..'))
22
# -- General configuration -----------------------------------------------------
24
# Add any Sphinx extension module names here, as strings. They can be extensions
25
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29
'sphinx.ext.intersphinx',
31
'sphinx.ext.coverage',
32
'sphinx.ext.viewcode']
34
# Configuration for sphinx.ext.todo
36
todo_include_todos = True
38
# Add any paths that contain templates here, relative to this directory.
41
# The suffix of source filenames.
42
source_suffix = '.rst'
44
# The encoding of source files.
45
#source_encoding = 'utf-8'
47
# The master toctree document.
50
# General information about the project.
51
project = u'LAVA Test'
52
copyright = u'2010-2011, Linaro Limited'
54
# The version info for the project you're documenting, acts as replacement for
55
# |version| and |release|, also used in various other places throughout the
58
# The short X.Y version.
61
version = "%d.%d" % lava_test.__version__[0:2]
62
# The full version, including alpha/beta/rc tags.
63
release = versiontools.format_version(lava_test.__version__)
65
# The language for content autogenerated by Sphinx. Refer to documentation
66
# for a list of supported languages.
69
# There are two options for replacing |today|: either, you set today to some
70
# non-false value, then it is used:
72
# Else, today_fmt is used as the format for a strftime call.
73
#today_fmt = '%B %d, %Y'
75
# List of documents that shouldn't be included in the build.
78
# List of directories, relative to source directory, that shouldn't be searched
82
# The reST default role (used for this markup: `text`) to use for all documents.
85
# If true, '()' will be appended to :func: etc. cross-reference text.
86
#add_function_parentheses = True
88
# If true, the current module name will be prepended to all description
89
# unit titles (such as .. function::).
90
#add_module_names = True
92
# If true, sectionauthor and moduleauthor directives will be shown in the
93
# output. They are ignored by default.
96
# The name of the Pygments (syntax highlighting) style to use.
97
pygments_style = 'sphinx'
99
# A list of ignored prefixes for module index sorting.
100
#modindex_common_prefix = []
103
# -- Options for HTML output ---------------------------------------------------
105
# The theme to use for HTML and HTML Help pages. Major themes that come with
106
# Sphinx are currently 'default' and 'sphinxdoc'.
107
html_theme = 'default'
109
# Theme options are theme-specific and customize the look and feel of a theme
110
# further. For a list of options available for each theme, see the
112
#html_theme_options = {}
114
# Add any paths that contain custom themes here, relative to this directory.
115
#html_theme_path = []
117
# The name for this set of Sphinx documents. If None, it defaults to
118
# "<project> v<release> documentation".
121
# A shorter title for the navigation bar. Default is the same as html_title.
122
#html_short_title = None
124
# The name of an image file (relative to this directory) to place at the top
128
# The name of an image file (within the static path) to use as favicon of the
129
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
133
# Add any paths that contain custom static files (such as style sheets) here,
134
# relative to this directory. They are copied after the builtin static files,
135
# so a file named "default.css" will overwrite the builtin "default.css".
136
html_static_path = []
138
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
139
# using the given strftime format.
140
#html_last_updated_fmt = '%b %d, %Y'
142
# If true, SmartyPants will be used to convert quotes and dashes to
143
# typographically correct entities.
144
#html_use_smartypants = True
146
# Custom sidebar templates, maps document names to template names.
149
# Additional templates that should be rendered to pages, maps page names to
151
#html_additional_pages = {}
153
# If false, no module index is generated.
154
#html_use_modindex = True
156
# If false, no index is generated.
157
#html_use_index = True
159
# If true, the index is split into individual pages for each letter.
160
#html_split_index = False
162
# If true, links to the reST sources are added to the pages.
163
#html_show_sourcelink = True
165
# If true, an OpenSearch description file will be output, and all pages will
166
# contain a <link> tag referring to it. The value of this option must be the
167
# base URL from which the finished HTML is served.
168
#html_use_opensearch = ''
170
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
171
#html_file_suffix = ''
173
# Output file base name for HTML help builder.
174
htmlhelp_basename = 'LAVATestDocumentation'
177
# -- Options for LaTeX output --------------------------------------------------
179
# The paper size ('letter' or 'a4').
180
#latex_paper_size = 'letter'
182
# The font size ('10pt', '11pt' or '12pt').
183
#latex_font_size = '10pt'
185
# Grouping the document tree into LaTeX files. List of tuples
186
# (source start file, target name, title, author, documentclass [howto/manual]).
188
('index', 'LAVA Test.tex', u'LAVA Test Documentation',
189
u'Zygmunt Krynicki', 'manual'),
192
# The name of an image file (relative to this directory) to place at the top of
196
# For "manual" documents, if this is true, then toplevel headings are parts,
198
#latex_use_parts = False
200
# Additional stuff for the LaTeX preamble.
203
# Documents to append as an appendix to all manuals.
204
#latex_appendices = []
206
# If false, no module index is generated.
207
#latex_use_modindex = True
210
# Example configuration for intersphinx: refer to the Python standard library.
211
intersphinx_mapping = {'http://docs.python.org/': None}
added
removed
doc/conf.py
