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