Statistics
| Branch: | Tag: | Revision:

root / docs / source / conf.py @ 4a669c71

History | View | Annotate | Download (7 kB)

1
# -*- coding: utf-8 -*-
2
#
3
# Pithos documentation build configuration file, created by
4
# sphinx-quickstart on Wed May 18 12:42:48 2011.
5
#
6
# This file is execfile()d with the current directory set to its containing dir.
7
#
8
# Note that not all possible configuration values are present in this
9
# autogenerated file.
10
#
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
13

    
14
import sys, os
15

    
16
# If extensions (or modules to document with autodoc) are in another directory,
17
# add these directories to sys.path here. If the directory is relative to the
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
sys.path.insert(0, os.path.abspath('../..'))
20

    
21
from synnefo import settings
22
from django.core.management import setup_environ
23
setup_environ(settings)
24

    
25
# -- General configuration -----------------------------------------------------
26

    
27
# If your documentation needs a minimal Sphinx version, state it here.
28
#needs_sphinx = '1.0'
29

    
30
# Add any Sphinx extension module names here, as strings. They can be extensions
31
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
33

    
34
# Add any paths that contain templates here, relative to this directory.
35
templates_path = ['_templates']
36

    
37
# The suffix of source filenames.
38
source_suffix = '.rst'
39

    
40
# The encoding of source files.
41
#source_encoding = 'utf-8-sig'
42

    
43
# The master toctree document.
44
master_doc = 'index'
45

    
46
# General information about the project.
47
project = u'Pithos'
48
copyright = u'2011, Pithos Storage Team'
49

    
50
# The version info for the project you're documenting, acts as replacement for
51
# |version| and |release|, also used in various other places throughout the
52
# built documents.
53
#
54
# The short X.Y version.
55
version = '2'
56
# The full version, including alpha/beta/rc tags.
57
release = '2'
58

    
59
# The language for content autogenerated by Sphinx. Refer to documentation
60
# for a list of supported languages.
61
#language = None
62

    
63
# There are two options for replacing |today|: either, you set today to some
64
# non-false value, then it is used:
65
#today = ''
66
# Else, today_fmt is used as the format for a strftime call.
67
#today_fmt = '%B %d, %Y'
68

    
69
# List of patterns, relative to source directory, that match files and
70
# directories to ignore when looking for source files.
71
exclude_patterns = ['_build']
72

    
73
# The reST default role (used for this markup: `text`) to use for all documents.
74
#default_role = None
75

    
76
# If true, '()' will be appended to :func: etc. cross-reference text.
77
#add_function_parentheses = True
78

    
79
# If true, the current module name will be prepended to all description
80
# unit titles (such as .. function::).
81
#add_module_names = True
82

    
83
# If true, sectionauthor and moduleauthor directives will be shown in the
84
# output. They are ignored by default.
85
#show_authors = False
86

    
87
# The name of the Pygments (syntax highlighting) style to use.
88
pygments_style = 'sphinx'
89

    
90
# A list of ignored prefixes for module index sorting.
91
#modindex_common_prefix = []
92

    
93

    
94
# -- Options for HTML output ---------------------------------------------------
95

    
96
# The theme to use for HTML and HTML Help pages.  See the documentation for
97
# a list of builtin themes.
98
html_theme = 'default'
99

    
100
# Theme options are theme-specific and customize the look and feel of a theme
101
# further.  For a list of options available for each theme, see the
102
# documentation.
103
#html_theme_options = {}
104

    
105
# Add any paths that contain custom themes here, relative to this directory.
106
#html_theme_path = []
107

    
108
# The name for this set of Sphinx documents.  If None, it defaults to
109
# "<project> v<release> documentation".
110
#html_title = None
111

    
112
# A shorter title for the navigation bar.  Default is the same as html_title.
113
#html_short_title = None
114

    
115
# The name of an image file (relative to this directory) to place at the top
116
# of the sidebar.
117
#html_logo = None
118

    
119
# The name of an image file (within the static path) to use as favicon of the
120
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
121
# pixels large.
122
#html_favicon = None
123

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

    
129
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
130
# using the given strftime format.
131
#html_last_updated_fmt = '%b %d, %Y'
132

    
133
# If true, SmartyPants will be used to convert quotes and dashes to
134
# typographically correct entities.
135
#html_use_smartypants = True
136

    
137
# Custom sidebar templates, maps document names to template names.
138
#html_sidebars = {}
139

    
140
# Additional templates that should be rendered to pages, maps page names to
141
# template names.
142
#html_additional_pages = {}
143

    
144
# If false, no module index is generated.
145
#html_domain_indices = True
146

    
147
# If false, no index is generated.
148
#html_use_index = True
149

    
150
# If true, the index is split into individual pages for each letter.
151
#html_split_index = False
152

    
153
# If true, links to the reST sources are added to the pages.
154
#html_show_sourcelink = True
155

    
156
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
157
#html_show_sphinx = True
158

    
159
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
160
#html_show_copyright = True
161

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

    
167
# This is the file name suffix for HTML files (e.g. ".xhtml").
168
#html_file_suffix = None
169

    
170
# Output file base name for HTML help builder.
171
htmlhelp_basename = 'Pithosdoc'
172

    
173

    
174
# -- Options for LaTeX output --------------------------------------------------
175

    
176
# The paper size ('letter' or 'a4').
177
#latex_paper_size = 'letter'
178

    
179
# The font size ('10pt', '11pt' or '12pt').
180
#latex_font_size = '10pt'
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', 'Pithos.tex', u'Pithos Documentation',
186
   u'Pithos Storage Team', '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
# Additional stuff for the LaTeX preamble.
204
#latex_preamble = ''
205

    
206
# Documents to append as an appendix to all manuals.
207
#latex_appendices = []
208

    
209
# If false, no module index is generated.
210
#latex_domain_indices = True
211

    
212

    
213
# -- Options for manual page output --------------------------------------------
214

    
215
# One entry per manual page. List of tuples
216
# (source start file, name, description, authors, manual section).
217
man_pages = [
218
    ('index', 'pithos', u'Pithos Documentation',
219
     [u'Pithos Storage Team'], 1)
220
]
221

    
222

    
223
autodoc_default_flags = ['members']