1 # -*- coding: utf-8 -*-
3 # Iotlab SFA driver documentation build configuration file, created by
4 # sphinx-quickstart on Tue Jul 2 11:53:15 2013.
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.
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 sys.path.insert(0, os.path.abspath('../../'))
21 sys.path.insert(0, os.path.abspath('../../../'))
22 sys.path.insert(0, os.path.abspath('../../../storage/'))
23 sys.path.insert(0, os.path.abspath('../../../../'))
24 sys.path.insert(0, os.path.abspath('../../../rspecs/elements/versions/'))
25 sys.path.insert(0, os.path.abspath('../../../rspecs/elements/'))
26 sys.path.insert(0, os.path.abspath('../../../importer/'))
29 # -- General configuration -----------------------------------------------------
31 # If your documentation needs a minimal Sphinx version, state it here.
34 # Add any Sphinx extension module names here, as strings. They can be extensions
35 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
36 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
38 # Add any paths that contain templates here, relative to this directory.
39 templates_path = ['_templates']
41 # The suffix of source filenames.
42 source_suffix = '.rst'
44 # The encoding of source files.
45 #source_encoding = 'utf-8-sig'
47 # The master toctree document.
50 # General information about the project.
51 project = u'Iotlab SFA driver'
52 copyright = u'2013, Sandrine Avakian '
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.
60 # The full version, including alpha/beta/rc tags.
63 # The language for content autogenerated by Sphinx. Refer to documentation
64 # for a list of supported languages.
67 # There are two options for replacing |today|: either, you set today to some
68 # non-false value, then it is used:
70 # Else, today_fmt is used as the format for a strftime call.
71 #today_fmt = '%B %d, %Y'
73 # List of patterns, relative to source directory, that match files and
74 # directories to ignore when looking for source files.
77 # The reST default role (used for this markup: `text`) to use for all documents.
80 # If true, '()' will be appended to :func: etc. cross-reference text.
81 #add_function_parentheses = True
83 # If true, the current module name will be prepended to all description
84 # unit titles (such as .. function::).
85 #add_module_names = True
87 # If true, sectionauthor and moduleauthor directives will be shown in the
88 # output. They are ignored by default.
91 # The name of the Pygments (syntax highlighting) style to use.
92 pygments_style = 'sphinx'
94 # A list of ignored prefixes for module index sorting.
95 #modindex_common_prefix = []
98 # -- Options for HTML output ---------------------------------------------------
100 # The theme to use for HTML and HTML Help pages. See the documentation for
101 # a list of builtin themes.
102 html_theme = 'default'
104 # Theme options are theme-specific and customize the look and feel of a theme
105 # further. For a list of options available for each theme, see the
107 #html_theme_options = {}
109 # Add any paths that contain custom themes here, relative to this directory.
110 #html_theme_path = []
112 # The name for this set of Sphinx documents. If None, it defaults to
113 # "<project> v<release> documentation".
116 # A shorter title for the navigation bar. Default is the same as html_title.
117 #html_short_title = None
119 # The name of an image file (relative to this directory) to place at the top
123 # The name of an image file (within the static path) to use as favicon of the
124 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
128 # Add any paths that contain custom static files (such as style sheets) here,
129 # relative to this directory. They are copied after the builtin static files,
130 # so a file named "default.css" will overwrite the builtin "default.css".
131 html_static_path = ['_static']
133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134 # using the given strftime format.
135 #html_last_updated_fmt = '%b %d, %Y'
137 # If true, SmartyPants will be used to convert quotes and dashes to
138 # typographically correct entities.
139 #html_use_smartypants = True
141 # Custom sidebar templates, maps document names to template names.
144 # Additional templates that should be rendered to pages, maps page names to
146 #html_additional_pages = {}
148 # If false, no module index is generated.
149 #html_domain_indices = True
151 # If false, no index is generated.
152 #html_use_index = True
154 # If true, the index is split into individual pages for each letter.
155 #html_split_index = False
157 # If true, links to the reST sources are added to the pages.
158 #html_show_sourcelink = True
160 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
161 #html_show_sphinx = True
163 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
164 #html_show_copyright = True
166 # If true, an OpenSearch description file will be output, and all pages will
167 # contain a <link> tag referring to it. The value of this option must be the
168 # base URL from which the finished HTML is served.
169 #html_use_opensearch = ''
171 # This is the file name suffix for HTML files (e.g. ".xhtml").
172 #html_file_suffix = None
174 # Output file base name for HTML help builder.
175 htmlhelp_basename = 'IotlabSFAdriverdoc'
178 # -- Options for LaTeX output --------------------------------------------------
181 # The paper size ('letterpaper' or 'a4paper').
182 #'papersize': 'letterpaper',
184 # The font size ('10pt', '11pt' or '12pt').
185 #'pointsize': '10pt',
187 # Additional stuff for the LaTeX preamble.
191 # Grouping the document tree into LaTeX files. List of tuples
192 # (source start file, target name, title, author, documentclass [howto/manual]).
194 ('index', 'IotlabSFAdriver.tex', u'Iotlab SFA driver Documentation',
195 u'Sandrine Avakian ', 'manual'),
198 # The name of an image file (relative to this directory) to place at the top of
202 # For "manual" documents, if this is true, then toplevel headings are parts,
204 #latex_use_parts = False
206 # If true, show page references after internal links.
207 #latex_show_pagerefs = False
209 # If true, show URL addresses after external links.
210 #latex_show_urls = False
212 # Documents to append as an appendix to all manuals.
213 #latex_appendices = []
215 # If false, no module index is generated.
216 #latex_domain_indices = True
219 # -- Options for manual page output --------------------------------------------
221 # One entry per manual page. List of tuples
222 # (source start file, name, description, authors, manual section).
224 ('index', 'iotlabsfadriver', u'Iotlab SFA driver Documentation',
225 [u'Sandrine Avakian '], 1)
228 # If true, show URL addresses after external links.
229 #man_show_urls = False
232 # -- Options for Texinfo output ------------------------------------------------
234 # Grouping the document tree into Texinfo files. List of tuples
235 # (source start file, target name, title, author,
236 # dir menu entry, description, category)
237 texinfo_documents = [
238 ('index', 'IotlabSFAdriver', u'Iotlab SFA driver Documentation',
239 u'Sandrine Avakian ', 'IotlabSFAdriver', 'One line description of project.',
243 # Documents to append as an appendix to all manuals.
244 #texinfo_appendices = []
246 # If false, no module index is generated.
247 #texinfo_domain_indices = True
249 # How to display URL addresses: 'footnote', 'no', or 'inline'.
250 #texinfo_show_urls = 'footnote'
253 # -- Options for Epub output ---------------------------------------------------
255 # Bibliographic Dublin Core info.
256 epub_title = u'Iotlab SFA driver'
257 epub_author = u'Sandrine Avakian '
258 epub_publisher = u'Sandrine Avakian '
259 epub_copyright = u'2013, Sandrine Avakian '
261 # The language of the text. It defaults to the language option
262 # or en if the language is not set.
265 # The scheme of the identifier. Typical schemes are ISBN or URL.
268 # The unique identifier of the text. This can be a ISBN number
269 # or the project homepage.
270 #epub_identifier = ''
272 # A unique identification for the text.
275 # A tuple containing the cover image and cover page html template filenames.
278 # HTML files that should be inserted before the pages created by sphinx.
279 # The format is a list of tuples containing the path and title.
282 # HTML files shat should be inserted after the pages created by sphinx.
283 # The format is a list of tuples containing the path and title.
284 #epub_post_files = []
286 # A list of files that should not be packed into the epub file.
287 #epub_exclude_files = []
289 # The depth of the table of contents in toc.ncx.
292 # Allow duplicate toc entries.
296 # Example configuration for intersphinx: refer to the Python standard library.
297 intersphinx_mapping = {'http://docs.python.org/': None}