Statistics
| Branch: | Revision:

root / docs / conf.py @ be350355

History | View | Annotate | Download (6.7 kB)

1
import sys, os
2

    
3
extensions = []
4

    
5
# Add any paths that contain templates here, relative to this directory.
6
templates_path = ['_templates']
7

    
8
# The suffix of source filenames.
9
source_suffix = '.rst'
10

    
11
# The encoding of source files.
12
#source_encoding = 'utf-8-sig'
13

    
14
# The master toctree document.
15
master_doc = 'index'
16

    
17
# General information about the project.
18
project = u'snf-occi'
19
copyright = u'2012, GRNET'
20

    
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
23
# built documents.
24
#
25
# The short X.Y version.
26
version = '0.1'
27
# The full version, including alpha/beta/rc tags.
28
release = '0.1'
29

    
30
# The language for content autogenerated by Sphinx. Refer to documentation
31
# for a list of supported languages.
32
#language = None
33

    
34
# There are two options for replacing |today|: either, you set today to some
35
# non-false value, then it is used:
36
#today = ''
37
# Else, today_fmt is used as the format for a strftime call.
38
#today_fmt = '%B %d, %Y'
39

    
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']
43

    
44
# The reST default role (used for this markup: `text`) to use for all documents.
45
#default_role = None
46

    
47
# If true, '()' will be appended to :func: etc. cross-reference text.
48
#add_function_parentheses = True
49

    
50
# If true, the current module name will be prepended to all description
51
# unit titles (such as .. function::).
52
#add_module_names = True
53

    
54
# If true, sectionauthor and moduleauthor directives will be shown in the
55
# output. They are ignored by default.
56
#show_authors = False
57

    
58
# The name of the Pygments (syntax highlighting) style to use.
59
pygments_style = 'sphinx'
60

    
61
# A list of ignored prefixes for module index sorting.
62
#modindex_common_prefix = []
63

    
64

    
65
# -- Options for HTML output ---------------------------------------------------
66

    
67
# The theme to use for HTML and HTML Help pages.  See the documentation for
68
# a list of builtin themes.
69
html_theme = 'nature'
70

    
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
73
# documentation.
74
#html_theme_options = {}
75

    
76
# Add any paths that contain custom themes here, relative to this directory.
77
#html_theme_path = []
78

    
79
# The name for this set of Sphinx documents.  If None, it defaults to
80
# "<project> v<release> documentation".
81
#html_title = None
82

    
83
# A shorter title for the navigation bar.  Default is the same as html_title.
84
#html_short_title = None
85

    
86
# The name of an image file (relative to this directory) to place at the top
87
# of the sidebar.
88
#html_logo = None
89

    
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
92
# pixels large.
93
#html_favicon = None
94

    
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']
99

    
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'
103

    
104
# If true, SmartyPants will be used to convert quotes and dashes to
105
# typographically correct entities.
106
#html_use_smartypants = True
107

    
108
# Custom sidebar templates, maps document names to template names.
109
#html_sidebars = {}
110

    
111
# Additional templates that should be rendered to pages, maps page names to
112
# template names.
113
#html_additional_pages = {}
114

    
115
# If false, no module index is generated.
116
#html_domain_indices = True
117

    
118
# If false, no index is generated.
119
#html_use_index = True
120

    
121
# If true, the index is split into individual pages for each letter.
122
#html_split_index = False
123

    
124
# If true, links to the reST sources are added to the pages.
125
#html_show_sourcelink = True
126

    
127
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
128
#html_show_sphinx = True
129

    
130
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
131
#html_show_copyright = True
132

    
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 = ''
137

    
138
# This is the file name suffix for HTML files (e.g. ".xhtml").
139
#html_file_suffix = None
140

    
141
# Output file base name for HTML help builder.
142
htmlhelp_basename = 'snf-occidoc'
143

    
144

    
145
# -- Options for LaTeX output --------------------------------------------------
146

    
147
latex_elements = {
148
# The paper size ('letterpaper' or 'a4paper').
149
#'papersize': 'letterpaper',
150

    
151
# The font size ('10pt', '11pt' or '12pt').
152
#'pointsize': '10pt',
153

    
154
# Additional stuff for the LaTeX preamble.
155
#'preamble': '',
156
}
157

    
158
# Grouping the document tree into LaTeX files. List of tuples
159
# (source start file, target name, title, author, documentclass [howto/manual]).
160
latex_documents = [
161
  ('index', 'snf-occi.tex', u'snf-occi Documentation',
162
   u'John Giannelos', 'manual'),
163
]
164

    
165
# The name of an image file (relative to this directory) to place at the top of
166
# the title page.
167
#latex_logo = None
168

    
169
# For "manual" documents, if this is true, then toplevel headings are parts,
170
# not chapters.
171
#latex_use_parts = False
172

    
173
# If true, show page references after internal links.
174
#latex_show_pagerefs = False
175

    
176
# If true, show URL addresses after external links.
177
#latex_show_urls = False
178

    
179
# Documents to append as an appendix to all manuals.
180
#latex_appendices = []
181

    
182
# If false, no module index is generated.
183
#latex_domain_indices = True
184

    
185

    
186
# -- Options for manual page output --------------------------------------------
187

    
188
# One entry per manual page. List of tuples
189
# (source start file, name, description, authors, manual section).
190
man_pages = [
191
    ('index', 'snf-occi', u'snf-occi Documentation',
192
     [u'John Giannelos'], 1)
193
]
194

    
195
# If true, show URL addresses after external links.
196
#man_show_urls = False
197

    
198

    
199
# -- Options for Texinfo output ------------------------------------------------
200

    
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.',
207
   'Miscellaneous'),
208
]
209

    
210
# Documents to append as an appendix to all manuals.
211
#texinfo_appendices = []
212

    
213
# If false, no module index is generated.
214
#texinfo_domain_indices = True
215

    
216
# How to display URL addresses: 'footnote', 'no', or 'inline'.
217
#texinfo_show_urls = 'footnote'
218

    
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/')
223
}