fix bug when #client not exist
[rainbowstream.git] / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # RainbowStream documentation build configuration file, created by
4 # sphinx-quickstart on Wed Jul 23 12:26:18 2014.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
18 #sys.path.insert(0, os.path.abspath('.'))
19
20 # -- General configuration ------------------------------------------------
21
22 # If your documentation needs a minimal Sphinx version, state it here.
23 #needs_sphinx = '1.0'
24
25 # Add any Sphinx extension module names here, as strings. They can be
26 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
27 # ones.
28 extensions = []
29
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
32
33 # The suffix of source filenames.
34 source_suffix = '.rst'
35
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
38
39 # The master toctree document.
40 master_doc = 'index'
41
42 # General information about the project.
43 project = u'RainbowStream'
44 copyright = u'2014, Vu Nhat Minh'
45
46 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the
48 # built documents.
49 #
50 # The short X.Y version.
51 version = '1.0.9'
52 # The full version, including alpha/beta/rc tags.
53 release = '1.0.9'
54
55 # The language for content autogenerated by Sphinx. Refer to documentation
56 # for a list of supported languages.
57 #language = None
58
59 # There are two options for replacing |today|: either, you set today to some
60 # non-false value, then it is used:
61 #today = ''
62 # Else, today_fmt is used as the format for a strftime call.
63 #today_fmt = '%B %d, %Y'
64
65 # List of patterns, relative to source directory, that match files and
66 # directories to ignore when looking for source files.
67 exclude_patterns = ['_build']
68
69 # The reST default role (used for this markup: `text`) to use for all
70 # documents.
71 #default_role = None
72
73 # If true, '()' will be appended to :func: etc. cross-reference text.
74 #add_function_parentheses = True
75
76 # If true, the current module name will be prepended to all description
77 # unit titles (such as .. function::).
78 #add_module_names = True
79
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
82 #show_authors = False
83
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
86
87 # A list of ignored prefixes for module index sorting.
88 #modindex_common_prefix = []
89
90 # If true, keep warnings as "system message" paragraphs in the built documents.
91 #keep_warnings = False
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 = 'nature'
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 # Add any extra paths that contain custom files (such as robots.txt or
130 # .htaccess) here, relative to this directory. These files are copied
131 # directly to the root of the documentation.
132 #html_extra_path = []
133
134 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
135 # using the given strftime format.
136 #html_last_updated_fmt = '%b %d, %Y'
137
138 # If true, SmartyPants will be used to convert quotes and dashes to
139 # typographically correct entities.
140 #html_use_smartypants = True
141
142 # Custom sidebar templates, maps document names to template names.
143 #html_sidebars = {}
144
145 # Additional templates that should be rendered to pages, maps page names to
146 # template names.
147 #html_additional_pages = {}
148
149 # If false, no module index is generated.
150 #html_domain_indices = True
151
152 # If false, no index is generated.
153 #html_use_index = True
154
155 # If true, the index is split into individual pages for each letter.
156 #html_split_index = False
157
158 # If true, links to the reST sources are added to the pages.
159 #html_show_sourcelink = True
160
161 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
162 #html_show_sphinx = True
163
164 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
165 #html_show_copyright = True
166
167 # If true, an OpenSearch description file will be output, and all pages will
168 # contain a <link> tag referring to it. The value of this option must be the
169 # base URL from which the finished HTML is served.
170 #html_use_opensearch = ''
171
172 # This is the file name suffix for HTML files (e.g. ".xhtml").
173 #html_file_suffix = None
174
175 # Output file base name for HTML help builder.
176 htmlhelp_basename = 'RainbowStreamdoc'
177
178
179 # -- Options for LaTeX output ---------------------------------------------
180
181 latex_elements = {
182 # The paper size ('letterpaper' or 'a4paper').
183 #'papersize': 'letterpaper',
184
185 # The font size ('10pt', '11pt' or '12pt').
186 #'pointsize': '10pt',
187
188 # Additional stuff for the LaTeX preamble.
189 #'preamble': '',
190 }
191
192 # Grouping the document tree into LaTeX files. List of tuples
193 # (source start file, target name, title,
194 # author, documentclass [howto, manual, or own class]).
195 latex_documents = [
196 ('index', 'RainbowStream.tex', u'RainbowStream Documentation',
197 u'Vu Nhat Minh', 'manual'),
198 ]
199
200 # The name of an image file (relative to this directory) to place at the top of
201 # the title page.
202 #latex_logo = None
203
204 # For "manual" documents, if this is true, then toplevel headings are parts,
205 # not chapters.
206 #latex_use_parts = False
207
208 # If true, show page references after internal links.
209 #latex_show_pagerefs = False
210
211 # If true, show URL addresses after external links.
212 #latex_show_urls = False
213
214 # Documents to append as an appendix to all manuals.
215 #latex_appendices = []
216
217 # If false, no module index is generated.
218 #latex_domain_indices = True
219
220
221 # -- Options for manual page output ---------------------------------------
222
223 # One entry per manual page. List of tuples
224 # (source start file, name, description, authors, manual section).
225 man_pages = [
226 ('index', 'rainbowstream', u'RainbowStream Documentation',
227 [u'Vu Nhat Minh'], 1)
228 ]
229
230 # If true, show URL addresses after external links.
231 #man_show_urls = False
232
233
234 # -- Options for Texinfo output -------------------------------------------
235
236 # Grouping the document tree into Texinfo files. List of tuples
237 # (source start file, target name, title, author,
238 # dir menu entry, description, category)
239 texinfo_documents = [
240 ('index', 'RainbowStream', u'RainbowStream Documentation',
241 u'Vu Nhat Minh', 'RainbowStream', 'One line description of project.',
242 'Miscellaneous'),
243 ]
244
245 # Documents to append as an appendix to all manuals.
246 #texinfo_appendices = []
247
248 # If false, no module index is generated.
249 #texinfo_domain_indices = True
250
251 # How to display URL addresses: 'footnote', 'no', or 'inline'.
252 #texinfo_show_urls = 'footnote'
253
254 # If true, do not generate a @detailmenu in the "Top" node's menu.
255 #texinfo_no_detailmenu = False