Statistics
| Branch: | Tag: | Revision:

root / snf-tools / docs / conf.py @ 693bebea

History | View | Annotate | Download (7.6 kB)

1
import sys, os
2

    
3
sys.path.insert(0, os.path.abspath('../'))
4
from synnefo_tools.version import __version__
5

    
6
extensions = []
7

    
8
# Add any paths that contain templates here, relative to this directory.
9
templates_path = ['_templates']
10

    
11
# The suffix of source filenames.
12
source_suffix = '.rst'
13

    
14
# The encoding of source files.
15
#source_encoding = 'utf-8-sig'
16

    
17
# The master toctree document.
18
master_doc = 'index'
19

    
20
# General information about the project.
21
project = u'snf-occi'
22
copyright = u'2012-2013, GRNET'
23

    
24
# The version info for the project you're documenting, acts as replacement for
25
# |version| and |release|, also used in various other places throughout the
26
# built documents.
27
#
28
# The short X.Y version.
29
version = __version__
30
# The full version, including alpha/beta/rc tags.
31
release = __version__
32

    
33
# The language for content autogenerated by Sphinx. Refer to documentation
34
# for a list of supported languages.
35
#language = None
36

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

    
43
# List of patterns, relative to source directory, that match files and
44
# directories to ignore when looking for source files.
45
exclude_patterns = ['_build']
46

    
47
# The reST default role (used for this markup: `text`) to use for all documents.
48
#default_role = None
49

    
50
# If true, '()' will be appended to :func: etc. cross-reference text.
51
#add_function_parentheses = True
52

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

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

    
61
# The name of the Pygments (syntax highlighting) style to use.
62
pygments_style = 'sphinx'
63

    
64
# A list of ignored prefixes for module index sorting.
65
#modindex_common_prefix = []
66

    
67

    
68
# -- Options for HTML output ---------------------------------------------------
69

    
70
# The theme to use for HTML and HTML Help pages.  See the documentation for
71
# a list of builtin themes.
72
html_theme = 'default'
73
html_theme_options = {
74
        'collapsiblesidebar': 'true',
75
        'footerbgcolor':    '#55b577',
76
        'footertextcolor':  '#000000',
77
        'sidebarbgcolor':   '#ffffff',
78
        'sidebarbtncolor':  '#f2f2f2',
79
        'sidebartextcolor': '#000000',
80
        'sidebarlinkcolor': '#328e4a',
81
        'relbarbgcolor':    '#55b577',
82
        'relbartextcolor':  '#ffffff',
83
        'relbarlinkcolor':  '#ffffff',
84
        'bgcolor':          '#ffffff',
85
        'textcolor':        '#000000',
86
        'headbgcolor':      '#ffffff',
87
        'headtextcolor':    '#000000',
88
        'headlinkcolor':    '#c60f0f',
89
        'linkcolor':        '#328e4a',
90
        'visitedlinkcolor': '#63409b',
91
        'codebgcolor':      '#eeffcc',
92
        'codetextcolor':    '#333333'
93
}
94

    
95
# Theme options are theme-specific and customize the look and feel of a theme
96
# further.  For a list of options available for each theme, see the
97
# documentation.
98
#html_theme_options = {}
99

    
100
# Add any paths that contain custom themes here, relative to this directory.
101
#html_theme_path = []
102

    
103
# The name for this set of Sphinx documents.  If None, it defaults to
104
# "<project> v<release> documentation".
105
#html_title = None
106

    
107
# A shorter title for the navigation bar.  Default is the same as html_title.
108
#html_short_title = None
109

    
110
# The name of an image file (relative to this directory) to place at the top
111
# of the sidebar.
112
#html_logo = None
113

    
114
# The name of an image file (within the static path) to use as favicon of the
115
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
116
# pixels large.
117
#html_favicon = None
118

    
119
# Add any paths that contain custom static files (such as style sheets) here,
120
# relative to this directory. They are copied after the builtin static files,
121
# so a file named "default.css" will overwrite the builtin "default.css".
122
html_static_path = ['_static']
123

    
124
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
125
# using the given strftime format.
126
#html_last_updated_fmt = '%b %d, %Y'
127

    
128
# If true, SmartyPants will be used to convert quotes and dashes to
129
# typographically correct entities.
130
#html_use_smartypants = True
131

    
132
# Custom sidebar templates, maps document names to template names.
133
#html_sidebars = {}
134

    
135
# Additional templates that should be rendered to pages, maps page names to
136
# template names.
137
#html_additional_pages = {}
138

    
139
# If false, no module index is generated.
140
#html_domain_indices = True
141

    
142
# If false, no index is generated.
143
#html_use_index = True
144

    
145
# If true, the index is split into individual pages for each letter.
146
#html_split_index = False
147

    
148
# If true, links to the reST sources are added to the pages.
149
#html_show_sourcelink = True
150

    
151
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
152
#html_show_sphinx = True
153

    
154
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
155
#html_show_copyright = True
156

    
157
# If true, an OpenSearch description file will be output, and all pages will
158
# contain a <link> tag referring to it.  The value of this option must be the
159
# base URL from which the finished HTML is served.
160
#html_use_opensearch = ''
161

    
162
# This is the file name suffix for HTML files (e.g. ".xhtml").
163
#html_file_suffix = None
164

    
165
# Output file base name for HTML help builder.
166
htmlhelp_basename = 'snf-occidoc'
167

    
168

    
169
# -- Options for LaTeX output --------------------------------------------------
170

    
171
latex_elements = {
172
# The paper size ('letterpaper' or 'a4paper').
173
#'papersize': 'letterpaper',
174

    
175
# The font size ('10pt', '11pt' or '12pt').
176
#'pointsize': '10pt',
177

    
178
# Additional stuff for the LaTeX preamble.
179
#'preamble': '',
180
}
181

    
182
# Grouping the document tree into LaTeX files. List of tuples
183
# (source start file, target name, title, author, documentclass [howto/manual]).
184
latex_documents = [
185
  ('index', 'snf-occi.tex', u'snf-occi Documentation',
186
   u'John Giannelos', 'manual'),
187
]
188

    
189
# The name of an image file (relative to this directory) to place at the top of
190
# the title page.
191
#latex_logo = None
192

    
193
# For "manual" documents, if this is true, then toplevel headings are parts,
194
# not chapters.
195
#latex_use_parts = False
196

    
197
# If true, show page references after internal links.
198
#latex_show_pagerefs = False
199

    
200
# If true, show URL addresses after external links.
201
#latex_show_urls = False
202

    
203
# Documents to append as an appendix to all manuals.
204
#latex_appendices = []
205

    
206
# If false, no module index is generated.
207
#latex_domain_indices = True
208

    
209

    
210
# -- Options for manual page output --------------------------------------------
211

    
212
# One entry per manual page. List of tuples
213
# (source start file, name, description, authors, manual section).
214
man_pages = [
215
    ('index', 'snf-occi', u'snf-occi Documentation',
216
     [u'John Giannelos'], 1)
217
]
218

    
219
# If true, show URL addresses after external links.
220
#man_show_urls = False
221

    
222

    
223
# -- Options for Texinfo output ------------------------------------------------
224

    
225
# Grouping the document tree into Texinfo files. List of tuples
226
# (source start file, target name, title, author,
227
#  dir menu entry, description, category)
228
texinfo_documents = [
229
  ('index', 'snf-occi', u'snf-occi Documentation',
230
   u'John Giannelos', 'snf-occi', 'One line description of project.',
231
   'Miscellaneous'),
232
]
233

    
234
# Documents to append as an appendix to all manuals.
235
#texinfo_appendices = []
236

    
237
# If false, no module index is generated.
238
#texinfo_domain_indices = True
239

    
240
# How to display URL addresses: 'footnote', 'no', or 'inline'.
241
#texinfo_show_urls = 'footnote'
242

    
243
intersphinx_mapping = {
244
    'python': ('http://docs.python.org/', None),
245
    'django': ('https://docs.djangoproject.com/en/dev/',
246
               'https://docs.djangoproject.com/en/dev/_objects/')
247
}