root / docs / conf.py @ cf6e8419
History | View | Annotate | Download (7.5 kB)
1 | cf6e8419 | Giorgos Verigakis | # -*- coding: utf-8 -*-
|
---|---|---|---|
2 | cf6e8419 | Giorgos Verigakis | #
|
3 | cf6e8419 | Giorgos Verigakis | # Kamaki documentation build configuration file, created by
|
4 | cf6e8419 | Giorgos Verigakis | # sphinx-quickstart on Tue Nov 29 15:15:50 2011.
|
5 | cf6e8419 | Giorgos Verigakis | #
|
6 | cf6e8419 | Giorgos Verigakis | # This file is execfile()d with the current directory set to its containing dir.
|
7 | cf6e8419 | Giorgos Verigakis | #
|
8 | cf6e8419 | Giorgos Verigakis | # Note that not all possible configuration values are present in this
|
9 | cf6e8419 | Giorgos Verigakis | # autogenerated file.
|
10 | cf6e8419 | Giorgos Verigakis | #
|
11 | cf6e8419 | Giorgos Verigakis | # All configuration values have a default; values that are commented out
|
12 | cf6e8419 | Giorgos Verigakis | # serve to show the default.
|
13 | cf6e8419 | Giorgos Verigakis | |
14 | cf6e8419 | Giorgos Verigakis | import sys, os |
15 | cf6e8419 | Giorgos Verigakis | |
16 | cf6e8419 | Giorgos Verigakis | # If extensions (or modules to document with autodoc) are in another directory,
|
17 | cf6e8419 | Giorgos Verigakis | # add these directories to sys.path here. If the directory is relative to the
|
18 | cf6e8419 | Giorgos Verigakis | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
19 | cf6e8419 | Giorgos Verigakis | sys.path.insert(0, os.path.abspath('..')) |
20 | cf6e8419 | Giorgos Verigakis | |
21 | cf6e8419 | Giorgos Verigakis | # -- General configuration -----------------------------------------------------
|
22 | cf6e8419 | Giorgos Verigakis | |
23 | cf6e8419 | Giorgos Verigakis | # If your documentation needs a minimal Sphinx version, state it here.
|
24 | cf6e8419 | Giorgos Verigakis | #needs_sphinx = '1.0'
|
25 | cf6e8419 | Giorgos Verigakis | |
26 | cf6e8419 | Giorgos Verigakis | # Add any Sphinx extension module names here, as strings. They can be extensions
|
27 | cf6e8419 | Giorgos Verigakis | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
28 | cf6e8419 | Giorgos Verigakis | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] |
29 | cf6e8419 | Giorgos Verigakis | |
30 | cf6e8419 | Giorgos Verigakis | # Add any paths that contain templates here, relative to this directory.
|
31 | cf6e8419 | Giorgos Verigakis | templates_path = ['_templates']
|
32 | cf6e8419 | Giorgos Verigakis | |
33 | cf6e8419 | Giorgos Verigakis | # The suffix of source filenames.
|
34 | cf6e8419 | Giorgos Verigakis | source_suffix = '.rst'
|
35 | cf6e8419 | Giorgos Verigakis | |
36 | cf6e8419 | Giorgos Verigakis | # The encoding of source files.
|
37 | cf6e8419 | Giorgos Verigakis | #source_encoding = 'utf-8-sig'
|
38 | cf6e8419 | Giorgos Verigakis | |
39 | cf6e8419 | Giorgos Verigakis | # The master toctree document.
|
40 | cf6e8419 | Giorgos Verigakis | master_doc = 'index'
|
41 | cf6e8419 | Giorgos Verigakis | |
42 | cf6e8419 | Giorgos Verigakis | # General information about the project.
|
43 | cf6e8419 | Giorgos Verigakis | project = u'Kamaki'
|
44 | cf6e8419 | Giorgos Verigakis | copyright = u'2011, GRNet'
|
45 | cf6e8419 | Giorgos Verigakis | |
46 | cf6e8419 | Giorgos Verigakis | # The version info for the project you're documenting, acts as replacement for
|
47 | cf6e8419 | Giorgos Verigakis | # |version| and |release|, also used in various other places throughout the
|
48 | cf6e8419 | Giorgos Verigakis | # built documents.
|
49 | cf6e8419 | Giorgos Verigakis | #
|
50 | cf6e8419 | Giorgos Verigakis | # The short X.Y version.
|
51 | cf6e8419 | Giorgos Verigakis | version = '0.2'
|
52 | cf6e8419 | Giorgos Verigakis | # The full version, including alpha/beta/rc tags.
|
53 | cf6e8419 | Giorgos Verigakis | release = '0.2'
|
54 | cf6e8419 | Giorgos Verigakis | |
55 | cf6e8419 | Giorgos Verigakis | # The language for content autogenerated by Sphinx. Refer to documentation
|
56 | cf6e8419 | Giorgos Verigakis | # for a list of supported languages.
|
57 | cf6e8419 | Giorgos Verigakis | #language = None
|
58 | cf6e8419 | Giorgos Verigakis | |
59 | cf6e8419 | Giorgos Verigakis | # There are two options for replacing |today|: either, you set today to some
|
60 | cf6e8419 | Giorgos Verigakis | # non-false value, then it is used:
|
61 | cf6e8419 | Giorgos Verigakis | #today = ''
|
62 | cf6e8419 | Giorgos Verigakis | # Else, today_fmt is used as the format for a strftime call.
|
63 | cf6e8419 | Giorgos Verigakis | #today_fmt = '%B %d, %Y'
|
64 | cf6e8419 | Giorgos Verigakis | |
65 | cf6e8419 | Giorgos Verigakis | # List of patterns, relative to source directory, that match files and
|
66 | cf6e8419 | Giorgos Verigakis | # directories to ignore when looking for source files.
|
67 | cf6e8419 | Giorgos Verigakis | exclude_patterns = ['_build']
|
68 | cf6e8419 | Giorgos Verigakis | |
69 | cf6e8419 | Giorgos Verigakis | # The reST default role (used for this markup: `text`) to use for all documents.
|
70 | cf6e8419 | Giorgos Verigakis | #default_role = None
|
71 | cf6e8419 | Giorgos Verigakis | |
72 | cf6e8419 | Giorgos Verigakis | # If true, '()' will be appended to :func: etc. cross-reference text.
|
73 | cf6e8419 | Giorgos Verigakis | #add_function_parentheses = True
|
74 | cf6e8419 | Giorgos Verigakis | |
75 | cf6e8419 | Giorgos Verigakis | # If true, the current module name will be prepended to all description
|
76 | cf6e8419 | Giorgos Verigakis | # unit titles (such as .. function::).
|
77 | cf6e8419 | Giorgos Verigakis | #add_module_names = True
|
78 | cf6e8419 | Giorgos Verigakis | |
79 | cf6e8419 | Giorgos Verigakis | # If true, sectionauthor and moduleauthor directives will be shown in the
|
80 | cf6e8419 | Giorgos Verigakis | # output. They are ignored by default.
|
81 | cf6e8419 | Giorgos Verigakis | #show_authors = False
|
82 | cf6e8419 | Giorgos Verigakis | |
83 | cf6e8419 | Giorgos Verigakis | # The name of the Pygments (syntax highlighting) style to use.
|
84 | cf6e8419 | Giorgos Verigakis | pygments_style = 'sphinx'
|
85 | cf6e8419 | Giorgos Verigakis | |
86 | cf6e8419 | Giorgos Verigakis | # A list of ignored prefixes for module index sorting.
|
87 | cf6e8419 | Giorgos Verigakis | #modindex_common_prefix = []
|
88 | cf6e8419 | Giorgos Verigakis | |
89 | cf6e8419 | Giorgos Verigakis | |
90 | cf6e8419 | Giorgos Verigakis | # -- Options for HTML output ---------------------------------------------------
|
91 | cf6e8419 | Giorgos Verigakis | |
92 | cf6e8419 | Giorgos Verigakis | # The theme to use for HTML and HTML Help pages. See the documentation for
|
93 | cf6e8419 | Giorgos Verigakis | # a list of builtin themes.
|
94 | cf6e8419 | Giorgos Verigakis | html_theme = 'nature'
|
95 | cf6e8419 | Giorgos Verigakis | |
96 | cf6e8419 | Giorgos Verigakis | # Theme options are theme-specific and customize the look and feel of a theme
|
97 | cf6e8419 | Giorgos Verigakis | # further. For a list of options available for each theme, see the
|
98 | cf6e8419 | Giorgos Verigakis | # documentation.
|
99 | cf6e8419 | Giorgos Verigakis | #html_theme_options = {}
|
100 | cf6e8419 | Giorgos Verigakis | |
101 | cf6e8419 | Giorgos Verigakis | # Add any paths that contain custom themes here, relative to this directory.
|
102 | cf6e8419 | Giorgos Verigakis | #html_theme_path = []
|
103 | cf6e8419 | Giorgos Verigakis | |
104 | cf6e8419 | Giorgos Verigakis | # The name for this set of Sphinx documents. If None, it defaults to
|
105 | cf6e8419 | Giorgos Verigakis | # "<project> v<release> documentation".
|
106 | cf6e8419 | Giorgos Verigakis | #html_title = None
|
107 | cf6e8419 | Giorgos Verigakis | |
108 | cf6e8419 | Giorgos Verigakis | # A shorter title for the navigation bar. Default is the same as html_title.
|
109 | cf6e8419 | Giorgos Verigakis | #html_short_title = None
|
110 | cf6e8419 | Giorgos Verigakis | |
111 | cf6e8419 | Giorgos Verigakis | # The name of an image file (relative to this directory) to place at the top
|
112 | cf6e8419 | Giorgos Verigakis | # of the sidebar.
|
113 | cf6e8419 | Giorgos Verigakis | #html_logo = None
|
114 | cf6e8419 | Giorgos Verigakis | |
115 | cf6e8419 | Giorgos Verigakis | # The name of an image file (within the static path) to use as favicon of the
|
116 | cf6e8419 | Giorgos Verigakis | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
117 | cf6e8419 | Giorgos Verigakis | # pixels large.
|
118 | cf6e8419 | Giorgos Verigakis | #html_favicon = None
|
119 | cf6e8419 | Giorgos Verigakis | |
120 | cf6e8419 | Giorgos Verigakis | # Add any paths that contain custom static files (such as style sheets) here,
|
121 | cf6e8419 | Giorgos Verigakis | # relative to this directory. They are copied after the builtin static files,
|
122 | cf6e8419 | Giorgos Verigakis | # so a file named "default.css" will overwrite the builtin "default.css".
|
123 | cf6e8419 | Giorgos Verigakis | html_static_path = ['_static']
|
124 | cf6e8419 | Giorgos Verigakis | |
125 | cf6e8419 | Giorgos Verigakis | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
126 | cf6e8419 | Giorgos Verigakis | # using the given strftime format.
|
127 | cf6e8419 | Giorgos Verigakis | #html_last_updated_fmt = '%b %d, %Y'
|
128 | cf6e8419 | Giorgos Verigakis | |
129 | cf6e8419 | Giorgos Verigakis | # If true, SmartyPants will be used to convert quotes and dashes to
|
130 | cf6e8419 | Giorgos Verigakis | # typographically correct entities.
|
131 | cf6e8419 | Giorgos Verigakis | #html_use_smartypants = True
|
132 | cf6e8419 | Giorgos Verigakis | |
133 | cf6e8419 | Giorgos Verigakis | # Custom sidebar templates, maps document names to template names.
|
134 | cf6e8419 | Giorgos Verigakis | #html_sidebars = {}
|
135 | cf6e8419 | Giorgos Verigakis | |
136 | cf6e8419 | Giorgos Verigakis | # Additional templates that should be rendered to pages, maps page names to
|
137 | cf6e8419 | Giorgos Verigakis | # template names.
|
138 | cf6e8419 | Giorgos Verigakis | #html_additional_pages = {}
|
139 | cf6e8419 | Giorgos Verigakis | |
140 | cf6e8419 | Giorgos Verigakis | # If false, no module index is generated.
|
141 | cf6e8419 | Giorgos Verigakis | #html_domain_indices = True
|
142 | cf6e8419 | Giorgos Verigakis | |
143 | cf6e8419 | Giorgos Verigakis | # If false, no index is generated.
|
144 | cf6e8419 | Giorgos Verigakis | #html_use_index = True
|
145 | cf6e8419 | Giorgos Verigakis | |
146 | cf6e8419 | Giorgos Verigakis | # If true, the index is split into individual pages for each letter.
|
147 | cf6e8419 | Giorgos Verigakis | #html_split_index = False
|
148 | cf6e8419 | Giorgos Verigakis | |
149 | cf6e8419 | Giorgos Verigakis | # If true, links to the reST sources are added to the pages.
|
150 | cf6e8419 | Giorgos Verigakis | #html_show_sourcelink = True
|
151 | cf6e8419 | Giorgos Verigakis | |
152 | cf6e8419 | Giorgos Verigakis | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
153 | cf6e8419 | Giorgos Verigakis | #html_show_sphinx = True
|
154 | cf6e8419 | Giorgos Verigakis | |
155 | cf6e8419 | Giorgos Verigakis | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
156 | cf6e8419 | Giorgos Verigakis | #html_show_copyright = True
|
157 | cf6e8419 | Giorgos Verigakis | |
158 | cf6e8419 | Giorgos Verigakis | # If true, an OpenSearch description file will be output, and all pages will
|
159 | cf6e8419 | Giorgos Verigakis | # contain a <link> tag referring to it. The value of this option must be the
|
160 | cf6e8419 | Giorgos Verigakis | # base URL from which the finished HTML is served.
|
161 | cf6e8419 | Giorgos Verigakis | #html_use_opensearch = ''
|
162 | cf6e8419 | Giorgos Verigakis | |
163 | cf6e8419 | Giorgos Verigakis | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
164 | cf6e8419 | Giorgos Verigakis | #html_file_suffix = None
|
165 | cf6e8419 | Giorgos Verigakis | |
166 | cf6e8419 | Giorgos Verigakis | # Output file base name for HTML help builder.
|
167 | cf6e8419 | Giorgos Verigakis | htmlhelp_basename = 'Kamakidoc'
|
168 | cf6e8419 | Giorgos Verigakis | |
169 | cf6e8419 | Giorgos Verigakis | |
170 | cf6e8419 | Giorgos Verigakis | # -- Options for LaTeX output --------------------------------------------------
|
171 | cf6e8419 | Giorgos Verigakis | |
172 | cf6e8419 | Giorgos Verigakis | latex_elements = { |
173 | cf6e8419 | Giorgos Verigakis | # The paper size ('letterpaper' or 'a4paper').
|
174 | cf6e8419 | Giorgos Verigakis | #'papersize': 'letterpaper',
|
175 | cf6e8419 | Giorgos Verigakis | |
176 | cf6e8419 | Giorgos Verigakis | # The font size ('10pt', '11pt' or '12pt').
|
177 | cf6e8419 | Giorgos Verigakis | #'pointsize': '10pt',
|
178 | cf6e8419 | Giorgos Verigakis | |
179 | cf6e8419 | Giorgos Verigakis | # Additional stuff for the LaTeX preamble.
|
180 | cf6e8419 | Giorgos Verigakis | #'preamble': '',
|
181 | cf6e8419 | Giorgos Verigakis | } |
182 | cf6e8419 | Giorgos Verigakis | |
183 | cf6e8419 | Giorgos Verigakis | # Grouping the document tree into LaTeX files. List of tuples
|
184 | cf6e8419 | Giorgos Verigakis | # (source start file, target name, title, author, documentclass [howto/manual]).
|
185 | cf6e8419 | Giorgos Verigakis | latex_documents = [ |
186 | cf6e8419 | Giorgos Verigakis | ('index', 'Kamaki.tex', u'Kamaki Documentation', |
187 | cf6e8419 | Giorgos Verigakis | u'GRNet', 'manual'), |
188 | cf6e8419 | Giorgos Verigakis | ] |
189 | cf6e8419 | Giorgos Verigakis | |
190 | cf6e8419 | Giorgos Verigakis | # The name of an image file (relative to this directory) to place at the top of
|
191 | cf6e8419 | Giorgos Verigakis | # the title page.
|
192 | cf6e8419 | Giorgos Verigakis | #latex_logo = None
|
193 | cf6e8419 | Giorgos Verigakis | |
194 | cf6e8419 | Giorgos Verigakis | # For "manual" documents, if this is true, then toplevel headings are parts,
|
195 | cf6e8419 | Giorgos Verigakis | # not chapters.
|
196 | cf6e8419 | Giorgos Verigakis | #latex_use_parts = False
|
197 | cf6e8419 | Giorgos Verigakis | |
198 | cf6e8419 | Giorgos Verigakis | # If true, show page references after internal links.
|
199 | cf6e8419 | Giorgos Verigakis | #latex_show_pagerefs = False
|
200 | cf6e8419 | Giorgos Verigakis | |
201 | cf6e8419 | Giorgos Verigakis | # If true, show URL addresses after external links.
|
202 | cf6e8419 | Giorgos Verigakis | #latex_show_urls = False
|
203 | cf6e8419 | Giorgos Verigakis | |
204 | cf6e8419 | Giorgos Verigakis | # Documents to append as an appendix to all manuals.
|
205 | cf6e8419 | Giorgos Verigakis | #latex_appendices = []
|
206 | cf6e8419 | Giorgos Verigakis | |
207 | cf6e8419 | Giorgos Verigakis | # If false, no module index is generated.
|
208 | cf6e8419 | Giorgos Verigakis | #latex_domain_indices = True
|
209 | cf6e8419 | Giorgos Verigakis | |
210 | cf6e8419 | Giorgos Verigakis | |
211 | cf6e8419 | Giorgos Verigakis | # -- Options for manual page output --------------------------------------------
|
212 | cf6e8419 | Giorgos Verigakis | |
213 | cf6e8419 | Giorgos Verigakis | # One entry per manual page. List of tuples
|
214 | cf6e8419 | Giorgos Verigakis | # (source start file, name, description, authors, manual section).
|
215 | cf6e8419 | Giorgos Verigakis | man_pages = [ |
216 | cf6e8419 | Giorgos Verigakis | ('index', 'kamaki', u'Kamaki Documentation', |
217 | cf6e8419 | Giorgos Verigakis | [u'GRNet'], 1) |
218 | cf6e8419 | Giorgos Verigakis | ] |
219 | cf6e8419 | Giorgos Verigakis | |
220 | cf6e8419 | Giorgos Verigakis | # If true, show URL addresses after external links.
|
221 | cf6e8419 | Giorgos Verigakis | #man_show_urls = False
|
222 | cf6e8419 | Giorgos Verigakis | |
223 | cf6e8419 | Giorgos Verigakis | |
224 | cf6e8419 | Giorgos Verigakis | # -- Options for Texinfo output ------------------------------------------------
|
225 | cf6e8419 | Giorgos Verigakis | |
226 | cf6e8419 | Giorgos Verigakis | # Grouping the document tree into Texinfo files. List of tuples
|
227 | cf6e8419 | Giorgos Verigakis | # (source start file, target name, title, author,
|
228 | cf6e8419 | Giorgos Verigakis | # dir menu entry, description, category)
|
229 | cf6e8419 | Giorgos Verigakis | texinfo_documents = [ |
230 | cf6e8419 | Giorgos Verigakis | ('index', 'Kamaki', u'Kamaki Documentation', |
231 | cf6e8419 | Giorgos Verigakis | u'GRNet', 'Kamaki', 'One line description of project.', |
232 | cf6e8419 | Giorgos Verigakis | 'Miscellaneous'),
|
233 | cf6e8419 | Giorgos Verigakis | ] |
234 | cf6e8419 | Giorgos Verigakis | |
235 | cf6e8419 | Giorgos Verigakis | # Documents to append as an appendix to all manuals.
|
236 | cf6e8419 | Giorgos Verigakis | #texinfo_appendices = []
|
237 | cf6e8419 | Giorgos Verigakis | |
238 | cf6e8419 | Giorgos Verigakis | # If false, no module index is generated.
|
239 | cf6e8419 | Giorgos Verigakis | #texinfo_domain_indices = True
|
240 | cf6e8419 | Giorgos Verigakis | |
241 | cf6e8419 | Giorgos Verigakis | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
242 | cf6e8419 | Giorgos Verigakis | #texinfo_show_urls = 'footnote' |