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