1 # -*- coding: utf-8 -*-
3 # snf-image documentation build configuration file, created by
4 # sphinx-quickstart on Fri Sep 13 16:50:13 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.append(os.path.abspath('.'))
21 # -- General configuration -----------------------------------------------------
23 # Add any Sphinx extension module names here, as strings. They can be extensions
24 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27 # Add any paths that contain templates here, relative to this directory.
28 templates_path = ['_templates']
30 # The suffix of source filenames.
31 source_suffix = '.rst'
33 # The encoding of source files.
34 #source_encoding = 'utf-8'
36 # The master toctree document.
39 # General information about the project.
40 project = u'snf-image'
41 copyright = u'2011, 2012, 2013 GRNET S.A. All rights reserved'
43 # The version info for the project you're documenting, acts as replacement for
44 # |version| and |release|, also used in various other places throughout the
47 # The short X.Y version.
49 # The full version, including alpha/beta/rc tags.
52 # The language for content autogenerated by Sphinx. Refer to documentation
53 # for a list of supported languages.
56 # There are two options for replacing |today|: either, you set today to some
57 # non-false value, then it is used:
59 # Else, today_fmt is used as the format for a strftime call.
60 #today_fmt = '%B %d, %Y'
62 # List of documents that shouldn't be included in the build.
65 # List of directories, relative to source directory, that shouldn't be searched
67 exclude_trees = ['_build']
69 # The reST default role (used for this markup: `text`) to use for all documents.
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
90 # -- Options for HTML output ---------------------------------------------------
92 # The theme to use for HTML and HTML Help pages. Major themes that come with
93 # Sphinx are currently 'default' and 'sphinxdoc'.
94 html_theme = 'default'
96 # Theme options are theme-specific and customize the look and feel of a theme
97 # further. For a list of options available for each theme, see the
99 html_theme_options = {
100 'collapsiblesidebar': 'true',
101 'footerbgcolor': '#55b577',
102 'footertextcolor': '#000000',
103 'sidebarbgcolor': '#ffffff',
104 'sidebarbtncolor': '#f2f2f2',
105 'sidebartextcolor': '#000000',
106 'sidebarlinkcolor': '#328e4a',
107 'relbarbgcolor': '#55b577',
108 'relbartextcolor': '#ffffff',
109 'relbarlinkcolor': '#ffffff',
110 'bgcolor': '#ffffff',
111 'textcolor': '#000000',
112 'headbgcolor': '#ffffff',
113 'headtextcolor': '#000000',
114 'headlinkcolor': '#c60f0f',
115 'linkcolor': '#328e4a',
116 'visitedlinkcolor': '#63409b',
117 'codebgcolor': '#eeffcc',
118 'codetextcolor': '#333333'
121 # Add any paths that contain custom themes here, relative to this directory.
122 #html_theme_path = []
124 # The name for this set of Sphinx documents. If None, it defaults to
125 # "<project> v<release> documentation".
128 # A shorter title for the navigation bar. Default is the same as html_title.
129 #html_short_title = None
131 # The name of an image file (relative to this directory) to place at the top
135 # The name of an image file (within the static path) to use as favicon of the
136 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140 # Add any paths that contain custom static files (such as style sheets) here,
141 # relative to this directory. They are copied after the builtin static files,
142 # so a file named "default.css" will overwrite the builtin "default.css".
143 html_static_path = ['_static']
145 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
146 # using the given strftime format.
147 #html_last_updated_fmt = '%b %d, %Y'
149 # If true, SmartyPants will be used to convert quotes and dashes to
150 # typographically correct entities.
151 #html_use_smartypants = True
153 # Custom sidebar templates, maps document names to template names.
156 # Additional templates that should be rendered to pages, maps page names to
158 #html_additional_pages = {}
160 # If false, no module index is generated.
161 #html_use_modindex = True
163 # If false, no index is generated.
164 #html_use_index = True
166 # If true, the index is split into individual pages for each letter.
167 #html_split_index = False
169 # If true, links to the reST sources are added to the pages.
170 #html_show_sourcelink = True
172 # If true, an OpenSearch description file will be output, and all pages will
173 # contain a <link> tag referring to it. The value of this option must be the
174 # base URL from which the finished HTML is served.
175 #html_use_opensearch = ''
177 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
178 #html_file_suffix = ''
180 # Output file base name for HTML help builder.
181 htmlhelp_basename = 'snf-imagedoc'
184 # -- Options for LaTeX output --------------------------------------------------
186 # The paper size ('letter' or 'a4').
187 #latex_paper_size = 'letter'
189 # The font size ('10pt', '11pt' or '12pt').
190 #latex_font_size = '10pt'
192 # Grouping the document tree into LaTeX files. List of tuples
193 # (source start file, target name, title, author, documentclass [howto/manual]).
195 ('index', 'snf-image.tex', u'snf-image Documentation',
196 u'Synnefo development team', 'manual'),
199 # The name of an image file (relative to this directory) to place at the top of
203 # For "manual" documents, if this is true, then toplevel headings are parts,
205 #latex_use_parts = False
207 # Additional stuff for the LaTeX preamble.
210 # Documents to append as an appendix to all manuals.
211 #latex_appendices = []
213 # If false, no module index is generated.
214 #latex_use_modindex = True