root / docs / conf.py @ aa2fe10d
History | View | Annotate | Download (6.9 kB)
1 | c53c01d5 | Nikos Skalkotos | # -*- coding: utf-8 -*-
|
---|---|---|---|
2 | c53c01d5 | Nikos Skalkotos | #
|
3 | c53c01d5 | Nikos Skalkotos | # snf-image documentation build configuration file, created by
|
4 | c53c01d5 | Nikos Skalkotos | # sphinx-quickstart on Fri Sep 13 16:50:13 2013.
|
5 | c53c01d5 | Nikos Skalkotos | #
|
6 | c53c01d5 | Nikos Skalkotos | # This file is execfile()d with the current directory set to its containing dir.
|
7 | c53c01d5 | Nikos Skalkotos | #
|
8 | c53c01d5 | Nikos Skalkotos | # Note that not all possible configuration values are present in this
|
9 | c53c01d5 | Nikos Skalkotos | # autogenerated file.
|
10 | c53c01d5 | Nikos Skalkotos | #
|
11 | c53c01d5 | Nikos Skalkotos | # All configuration values have a default; values that are commented out
|
12 | c53c01d5 | Nikos Skalkotos | # serve to show the default.
|
13 | c53c01d5 | Nikos Skalkotos | |
14 | c53c01d5 | Nikos Skalkotos | import sys, os |
15 | c53c01d5 | Nikos Skalkotos | |
16 | c53c01d5 | Nikos Skalkotos | # If extensions (or modules to document with autodoc) are in another directory,
|
17 | c53c01d5 | Nikos Skalkotos | # add these directories to sys.path here. If the directory is relative to the
|
18 | c53c01d5 | Nikos Skalkotos | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
19 | c53c01d5 | Nikos Skalkotos | #sys.path.append(os.path.abspath('.'))
|
20 | c53c01d5 | Nikos Skalkotos | |
21 | c53c01d5 | Nikos Skalkotos | # -- General configuration -----------------------------------------------------
|
22 | c53c01d5 | Nikos Skalkotos | |
23 | c53c01d5 | Nikos Skalkotos | # Add any Sphinx extension module names here, as strings. They can be extensions
|
24 | c53c01d5 | Nikos Skalkotos | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
25 | c53c01d5 | Nikos Skalkotos | extensions = [] |
26 | c53c01d5 | Nikos Skalkotos | |
27 | c53c01d5 | Nikos Skalkotos | # Add any paths that contain templates here, relative to this directory.
|
28 | c53c01d5 | Nikos Skalkotos | templates_path = ['_templates']
|
29 | c53c01d5 | Nikos Skalkotos | |
30 | c53c01d5 | Nikos Skalkotos | # The suffix of source filenames.
|
31 | c53c01d5 | Nikos Skalkotos | source_suffix = '.rst'
|
32 | c53c01d5 | Nikos Skalkotos | |
33 | c53c01d5 | Nikos Skalkotos | # The encoding of source files.
|
34 | c53c01d5 | Nikos Skalkotos | #source_encoding = 'utf-8'
|
35 | c53c01d5 | Nikos Skalkotos | |
36 | c53c01d5 | Nikos Skalkotos | # The master toctree document.
|
37 | c53c01d5 | Nikos Skalkotos | master_doc = 'index'
|
38 | c53c01d5 | Nikos Skalkotos | |
39 | c53c01d5 | Nikos Skalkotos | # General information about the project.
|
40 | c53c01d5 | Nikos Skalkotos | project = u'snf-image'
|
41 | c53c01d5 | Nikos Skalkotos | copyright = u'2011, 2012, 2013 GRNET S.A. All rights reserved'
|
42 | c53c01d5 | Nikos Skalkotos | |
43 | c53c01d5 | Nikos Skalkotos | # The version info for the project you're documenting, acts as replacement for
|
44 | c53c01d5 | Nikos Skalkotos | # |version| and |release|, also used in various other places throughout the
|
45 | c53c01d5 | Nikos Skalkotos | # built documents.
|
46 | c53c01d5 | Nikos Skalkotos | #
|
47 | c53c01d5 | Nikos Skalkotos | # The short X.Y version.
|
48 | aa2fe10d | Nikos Skalkotos | version = '0.12'
|
49 | c53c01d5 | Nikos Skalkotos | # The full version, including alpha/beta/rc tags.
|
50 | aa2fe10d | Nikos Skalkotos | release = '0.12'
|
51 | c53c01d5 | Nikos Skalkotos | |
52 | c53c01d5 | Nikos Skalkotos | # The language for content autogenerated by Sphinx. Refer to documentation
|
53 | c53c01d5 | Nikos Skalkotos | # for a list of supported languages.
|
54 | c53c01d5 | Nikos Skalkotos | #language = None
|
55 | c53c01d5 | Nikos Skalkotos | |
56 | c53c01d5 | Nikos Skalkotos | # There are two options for replacing |today|: either, you set today to some
|
57 | c53c01d5 | Nikos Skalkotos | # non-false value, then it is used:
|
58 | c53c01d5 | Nikos Skalkotos | #today = ''
|
59 | c53c01d5 | Nikos Skalkotos | # Else, today_fmt is used as the format for a strftime call.
|
60 | c53c01d5 | Nikos Skalkotos | #today_fmt = '%B %d, %Y'
|
61 | c53c01d5 | Nikos Skalkotos | |
62 | c53c01d5 | Nikos Skalkotos | # List of documents that shouldn't be included in the build.
|
63 | c53c01d5 | Nikos Skalkotos | #unused_docs = []
|
64 | c53c01d5 | Nikos Skalkotos | |
65 | c53c01d5 | Nikos Skalkotos | # List of directories, relative to source directory, that shouldn't be searched
|
66 | c53c01d5 | Nikos Skalkotos | # for source files.
|
67 | c53c01d5 | Nikos Skalkotos | exclude_trees = ['_build']
|
68 | c53c01d5 | Nikos Skalkotos | |
69 | c53c01d5 | Nikos Skalkotos | # The reST default role (used for this markup: `text`) to use for all documents.
|
70 | c53c01d5 | Nikos Skalkotos | #default_role = None
|
71 | c53c01d5 | Nikos Skalkotos | |
72 | c53c01d5 | Nikos Skalkotos | # If true, '()' will be appended to :func: etc. cross-reference text.
|
73 | c53c01d5 | Nikos Skalkotos | #add_function_parentheses = True
|
74 | c53c01d5 | Nikos Skalkotos | |
75 | c53c01d5 | Nikos Skalkotos | # If true, the current module name will be prepended to all description
|
76 | c53c01d5 | Nikos Skalkotos | # unit titles (such as .. function::).
|
77 | c53c01d5 | Nikos Skalkotos | #add_module_names = True
|
78 | c53c01d5 | Nikos Skalkotos | |
79 | c53c01d5 | Nikos Skalkotos | # If true, sectionauthor and moduleauthor directives will be shown in the
|
80 | c53c01d5 | Nikos Skalkotos | # output. They are ignored by default.
|
81 | c53c01d5 | Nikos Skalkotos | #show_authors = False
|
82 | c53c01d5 | Nikos Skalkotos | |
83 | c53c01d5 | Nikos Skalkotos | # The name of the Pygments (syntax highlighting) style to use.
|
84 | c53c01d5 | Nikos Skalkotos | pygments_style = 'sphinx'
|
85 | c53c01d5 | Nikos Skalkotos | |
86 | c53c01d5 | Nikos Skalkotos | # A list of ignored prefixes for module index sorting.
|
87 | c53c01d5 | Nikos Skalkotos | #modindex_common_prefix = []
|
88 | c53c01d5 | Nikos Skalkotos | |
89 | c53c01d5 | Nikos Skalkotos | |
90 | c53c01d5 | Nikos Skalkotos | # -- Options for HTML output ---------------------------------------------------
|
91 | c53c01d5 | Nikos Skalkotos | |
92 | c53c01d5 | Nikos Skalkotos | # The theme to use for HTML and HTML Help pages. Major themes that come with
|
93 | c53c01d5 | Nikos Skalkotos | # Sphinx are currently 'default' and 'sphinxdoc'.
|
94 | c53c01d5 | Nikos Skalkotos | html_theme = 'default'
|
95 | c53c01d5 | Nikos Skalkotos | |
96 | c53c01d5 | Nikos Skalkotos | # Theme options are theme-specific and customize the look and feel of a theme
|
97 | c53c01d5 | Nikos Skalkotos | # further. For a list of options available for each theme, see the
|
98 | c53c01d5 | Nikos Skalkotos | # documentation.
|
99 | c53c01d5 | Nikos Skalkotos | html_theme_options = { |
100 | c53c01d5 | Nikos Skalkotos | 'collapsiblesidebar': 'true', |
101 | c53c01d5 | Nikos Skalkotos | 'footerbgcolor': '#55b577', |
102 | c53c01d5 | Nikos Skalkotos | 'footertextcolor': '#000000', |
103 | c53c01d5 | Nikos Skalkotos | 'sidebarbgcolor': '#ffffff', |
104 | c53c01d5 | Nikos Skalkotos | 'sidebarbtncolor': '#f2f2f2', |
105 | c53c01d5 | Nikos Skalkotos | 'sidebartextcolor': '#000000', |
106 | c53c01d5 | Nikos Skalkotos | 'sidebarlinkcolor': '#328e4a', |
107 | c53c01d5 | Nikos Skalkotos | 'relbarbgcolor': '#55b577', |
108 | c53c01d5 | Nikos Skalkotos | 'relbartextcolor': '#ffffff', |
109 | c53c01d5 | Nikos Skalkotos | 'relbarlinkcolor': '#ffffff', |
110 | c53c01d5 | Nikos Skalkotos | 'bgcolor': '#ffffff', |
111 | c53c01d5 | Nikos Skalkotos | 'textcolor': '#000000', |
112 | c53c01d5 | Nikos Skalkotos | 'headbgcolor': '#ffffff', |
113 | c53c01d5 | Nikos Skalkotos | 'headtextcolor': '#000000', |
114 | c53c01d5 | Nikos Skalkotos | 'headlinkcolor': '#c60f0f', |
115 | c53c01d5 | Nikos Skalkotos | 'linkcolor': '#328e4a', |
116 | c53c01d5 | Nikos Skalkotos | 'visitedlinkcolor': '#63409b', |
117 | c53c01d5 | Nikos Skalkotos | 'codebgcolor': '#eeffcc', |
118 | c53c01d5 | Nikos Skalkotos | 'codetextcolor': '#333333' |
119 | c53c01d5 | Nikos Skalkotos | } |
120 | c53c01d5 | Nikos Skalkotos | |
121 | c53c01d5 | Nikos Skalkotos | # Add any paths that contain custom themes here, relative to this directory.
|
122 | c53c01d5 | Nikos Skalkotos | #html_theme_path = []
|
123 | c53c01d5 | Nikos Skalkotos | |
124 | c53c01d5 | Nikos Skalkotos | # The name for this set of Sphinx documents. If None, it defaults to
|
125 | c53c01d5 | Nikos Skalkotos | # "<project> v<release> documentation".
|
126 | c53c01d5 | Nikos Skalkotos | #html_title = None
|
127 | c53c01d5 | Nikos Skalkotos | |
128 | c53c01d5 | Nikos Skalkotos | # A shorter title for the navigation bar. Default is the same as html_title.
|
129 | c53c01d5 | Nikos Skalkotos | #html_short_title = None
|
130 | c53c01d5 | Nikos Skalkotos | |
131 | c53c01d5 | Nikos Skalkotos | # The name of an image file (relative to this directory) to place at the top
|
132 | c53c01d5 | Nikos Skalkotos | # of the sidebar.
|
133 | c53c01d5 | Nikos Skalkotos | #html_logo = None
|
134 | c53c01d5 | Nikos Skalkotos | |
135 | c53c01d5 | Nikos Skalkotos | # The name of an image file (within the static path) to use as favicon of the
|
136 | c53c01d5 | Nikos Skalkotos | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
137 | c53c01d5 | Nikos Skalkotos | # pixels large.
|
138 | c53c01d5 | Nikos Skalkotos | #html_favicon = None
|
139 | c53c01d5 | Nikos Skalkotos | |
140 | c53c01d5 | Nikos Skalkotos | # Add any paths that contain custom static files (such as style sheets) here,
|
141 | c53c01d5 | Nikos Skalkotos | # relative to this directory. They are copied after the builtin static files,
|
142 | c53c01d5 | Nikos Skalkotos | # so a file named "default.css" will overwrite the builtin "default.css".
|
143 | c53c01d5 | Nikos Skalkotos | html_static_path = ['_static']
|
144 | c53c01d5 | Nikos Skalkotos | |
145 | c53c01d5 | Nikos Skalkotos | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
146 | c53c01d5 | Nikos Skalkotos | # using the given strftime format.
|
147 | c53c01d5 | Nikos Skalkotos | #html_last_updated_fmt = '%b %d, %Y'
|
148 | c53c01d5 | Nikos Skalkotos | |
149 | c53c01d5 | Nikos Skalkotos | # If true, SmartyPants will be used to convert quotes and dashes to
|
150 | c53c01d5 | Nikos Skalkotos | # typographically correct entities.
|
151 | c53c01d5 | Nikos Skalkotos | #html_use_smartypants = True
|
152 | c53c01d5 | Nikos Skalkotos | |
153 | c53c01d5 | Nikos Skalkotos | # Custom sidebar templates, maps document names to template names.
|
154 | c53c01d5 | Nikos Skalkotos | #html_sidebars = {}
|
155 | c53c01d5 | Nikos Skalkotos | |
156 | c53c01d5 | Nikos Skalkotos | # Additional templates that should be rendered to pages, maps page names to
|
157 | c53c01d5 | Nikos Skalkotos | # template names.
|
158 | c53c01d5 | Nikos Skalkotos | #html_additional_pages = {}
|
159 | c53c01d5 | Nikos Skalkotos | |
160 | c53c01d5 | Nikos Skalkotos | # If false, no module index is generated.
|
161 | c53c01d5 | Nikos Skalkotos | #html_use_modindex = True
|
162 | c53c01d5 | Nikos Skalkotos | |
163 | c53c01d5 | Nikos Skalkotos | # If false, no index is generated.
|
164 | c53c01d5 | Nikos Skalkotos | #html_use_index = True
|
165 | c53c01d5 | Nikos Skalkotos | |
166 | c53c01d5 | Nikos Skalkotos | # If true, the index is split into individual pages for each letter.
|
167 | c53c01d5 | Nikos Skalkotos | #html_split_index = False
|
168 | c53c01d5 | Nikos Skalkotos | |
169 | c53c01d5 | Nikos Skalkotos | # If true, links to the reST sources are added to the pages.
|
170 | c53c01d5 | Nikos Skalkotos | #html_show_sourcelink = True
|
171 | c53c01d5 | Nikos Skalkotos | |
172 | c53c01d5 | Nikos Skalkotos | # If true, an OpenSearch description file will be output, and all pages will
|
173 | c53c01d5 | Nikos Skalkotos | # contain a <link> tag referring to it. The value of this option must be the
|
174 | c53c01d5 | Nikos Skalkotos | # base URL from which the finished HTML is served.
|
175 | c53c01d5 | Nikos Skalkotos | #html_use_opensearch = ''
|
176 | c53c01d5 | Nikos Skalkotos | |
177 | c53c01d5 | Nikos Skalkotos | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
178 | c53c01d5 | Nikos Skalkotos | #html_file_suffix = ''
|
179 | c53c01d5 | Nikos Skalkotos | |
180 | c53c01d5 | Nikos Skalkotos | # Output file base name for HTML help builder.
|
181 | c53c01d5 | Nikos Skalkotos | htmlhelp_basename = 'snf-imagedoc'
|
182 | c53c01d5 | Nikos Skalkotos | |
183 | c53c01d5 | Nikos Skalkotos | |
184 | c53c01d5 | Nikos Skalkotos | # -- Options for LaTeX output --------------------------------------------------
|
185 | c53c01d5 | Nikos Skalkotos | |
186 | c53c01d5 | Nikos Skalkotos | # The paper size ('letter' or 'a4').
|
187 | c53c01d5 | Nikos Skalkotos | #latex_paper_size = 'letter'
|
188 | c53c01d5 | Nikos Skalkotos | |
189 | c53c01d5 | Nikos Skalkotos | # The font size ('10pt', '11pt' or '12pt').
|
190 | c53c01d5 | Nikos Skalkotos | #latex_font_size = '10pt'
|
191 | c53c01d5 | Nikos Skalkotos | |
192 | c53c01d5 | Nikos Skalkotos | # Grouping the document tree into LaTeX files. List of tuples
|
193 | c53c01d5 | Nikos Skalkotos | # (source start file, target name, title, author, documentclass [howto/manual]).
|
194 | c53c01d5 | Nikos Skalkotos | latex_documents = [ |
195 | c53c01d5 | Nikos Skalkotos | ('index', 'snf-image.tex', u'snf-image Documentation', |
196 | c53c01d5 | Nikos Skalkotos | u'Synnefo development team', 'manual'), |
197 | c53c01d5 | Nikos Skalkotos | ] |
198 | c53c01d5 | Nikos Skalkotos | |
199 | c53c01d5 | Nikos Skalkotos | # The name of an image file (relative to this directory) to place at the top of
|
200 | c53c01d5 | Nikos Skalkotos | # the title page.
|
201 | c53c01d5 | Nikos Skalkotos | #latex_logo = None
|
202 | c53c01d5 | Nikos Skalkotos | |
203 | c53c01d5 | Nikos Skalkotos | # For "manual" documents, if this is true, then toplevel headings are parts,
|
204 | c53c01d5 | Nikos Skalkotos | # not chapters.
|
205 | c53c01d5 | Nikos Skalkotos | #latex_use_parts = False
|
206 | c53c01d5 | Nikos Skalkotos | |
207 | c53c01d5 | Nikos Skalkotos | # Additional stuff for the LaTeX preamble.
|
208 | c53c01d5 | Nikos Skalkotos | #latex_preamble = ''
|
209 | c53c01d5 | Nikos Skalkotos | |
210 | c53c01d5 | Nikos Skalkotos | # Documents to append as an appendix to all manuals.
|
211 | c53c01d5 | Nikos Skalkotos | #latex_appendices = []
|
212 | c53c01d5 | Nikos Skalkotos | |
213 | c53c01d5 | Nikos Skalkotos | # If false, no module index is generated.
|
214 | c53c01d5 | Nikos Skalkotos | #latex_use_modindex = True |