5 # Add any paths that contain templates here, relative to this directory.
6 templates_path = ['_templates']
8 # The suffix of source filenames.
11 # The encoding of source files.
12 #source_encoding = 'utf-8-sig'
14 # The master toctree document.
17 # General information about the project.
19 copyright = u'2012, GRNET'
21 # The version info for the project you're documenting, acts as replacement for
22 # |version| and |release|, also used in various other places throughout the
25 # The short X.Y version.
27 # The full version, including alpha/beta/rc tags.
30 # The language for content autogenerated by Sphinx. Refer to documentation
31 # for a list of supported languages.
34 # There are two options for replacing |today|: either, you set today to some
35 # non-false value, then it is used:
37 # Else, today_fmt is used as the format for a strftime call.
38 #today_fmt = '%B %d, %Y'
40 # List of patterns, relative to source directory, that match files and
41 # directories to ignore when looking for source files.
42 exclude_patterns = ['_build']
44 # The reST default role (used for this markup: `text`) to use for all documents.
47 # If true, '()' will be appended to :func: etc. cross-reference text.
48 #add_function_parentheses = True
50 # If true, the current module name will be prepended to all description
51 # unit titles (such as .. function::).
52 #add_module_names = True
54 # If true, sectionauthor and moduleauthor directives will be shown in the
55 # output. They are ignored by default.
58 # The name of the Pygments (syntax highlighting) style to use.
59 pygments_style = 'sphinx'
61 # A list of ignored prefixes for module index sorting.
62 #modindex_common_prefix = []
65 # -- Options for HTML output ---------------------------------------------------
67 # The theme to use for HTML and HTML Help pages. See the documentation for
68 # a list of builtin themes.
71 # Theme options are theme-specific and customize the look and feel of a theme
72 # further. For a list of options available for each theme, see the
74 #html_theme_options = {}
76 # Add any paths that contain custom themes here, relative to this directory.
79 # The name for this set of Sphinx documents. If None, it defaults to
80 # "<project> v<release> documentation".
83 # A shorter title for the navigation bar. Default is the same as html_title.
84 #html_short_title = None
86 # The name of an image file (relative to this directory) to place at the top
90 # The name of an image file (within the static path) to use as favicon of the
91 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
95 # Add any paths that contain custom static files (such as style sheets) here,
96 # relative to this directory. They are copied after the builtin static files,
97 # so a file named "default.css" will overwrite the builtin "default.css".
98 html_static_path = ['_static']
100 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
101 # using the given strftime format.
102 #html_last_updated_fmt = '%b %d, %Y'
104 # If true, SmartyPants will be used to convert quotes and dashes to
105 # typographically correct entities.
106 #html_use_smartypants = True
108 # Custom sidebar templates, maps document names to template names.
111 # Additional templates that should be rendered to pages, maps page names to
113 #html_additional_pages = {}
115 # If false, no module index is generated.
116 #html_domain_indices = True
118 # If false, no index is generated.
119 #html_use_index = True
121 # If true, the index is split into individual pages for each letter.
122 #html_split_index = False
124 # If true, links to the reST sources are added to the pages.
125 #html_show_sourcelink = True
127 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
128 #html_show_sphinx = True
130 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
131 #html_show_copyright = True
133 # If true, an OpenSearch description file will be output, and all pages will
134 # contain a <link> tag referring to it. The value of this option must be the
135 # base URL from which the finished HTML is served.
136 #html_use_opensearch = ''
138 # This is the file name suffix for HTML files (e.g. ".xhtml").
139 #html_file_suffix = None
141 # Output file base name for HTML help builder.
142 htmlhelp_basename = 'snf-occidoc'
145 # -- Options for LaTeX output --------------------------------------------------
148 # The paper size ('letterpaper' or 'a4paper').
149 #'papersize': 'letterpaper',
151 # The font size ('10pt', '11pt' or '12pt').
152 #'pointsize': '10pt',
154 # Additional stuff for the LaTeX preamble.
158 # Grouping the document tree into LaTeX files. List of tuples
159 # (source start file, target name, title, author, documentclass [howto/manual]).
161 ('index', 'snf-occi.tex', u'snf-occi Documentation',
162 u'John Giannelos', 'manual'),
165 # The name of an image file (relative to this directory) to place at the top of
169 # For "manual" documents, if this is true, then toplevel headings are parts,
171 #latex_use_parts = False
173 # If true, show page references after internal links.
174 #latex_show_pagerefs = False
176 # If true, show URL addresses after external links.
177 #latex_show_urls = False
179 # Documents to append as an appendix to all manuals.
180 #latex_appendices = []
182 # If false, no module index is generated.
183 #latex_domain_indices = True
186 # -- Options for manual page output --------------------------------------------
188 # One entry per manual page. List of tuples
189 # (source start file, name, description, authors, manual section).
191 ('index', 'snf-occi', u'snf-occi Documentation',
192 [u'John Giannelos'], 1)
195 # If true, show URL addresses after external links.
196 #man_show_urls = False
199 # -- Options for Texinfo output ------------------------------------------------
201 # Grouping the document tree into Texinfo files. List of tuples
202 # (source start file, target name, title, author,
203 # dir menu entry, description, category)
204 texinfo_documents = [
205 ('index', 'snf-occi', u'snf-occi Documentation',
206 u'John Giannelos', 'snf-occi', 'One line description of project.',
210 # Documents to append as an appendix to all manuals.
211 #texinfo_appendices = []
213 # If false, no module index is generated.
214 #texinfo_domain_indices = True
216 # How to display URL addresses: 'footnote', 'no', or 'inline'.
217 #texinfo_show_urls = 'footnote'
219 intersphinx_mapping = {
220 'python': ('http://docs.python.org/', None),
221 'django': ('https://docs.djangoproject.com/en/dev/',
222 'https://docs.djangoproject.com/en/dev/_objects/')