c264071c |
1 | # -*- coding: utf-8 -*- |
2 | # |
3 | # Rainbow Stream documentation build configuration file, created by |
4 | # sphinx-quickstart on Mon Jun 30 17:12:05 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 | import sys |
16 | import os |
17 | |
18 | # If extensions (or modules to document with autodoc) are in another directory, |
19 | # add these directories to sys.path here. If the directory is relative to the |
20 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
21 | #sys.path.insert(0, os.path.abspath('.')) |
22 | |
23 | # -- General configuration ------------------------------------------------ |
24 | |
25 | # If your documentation needs a minimal Sphinx version, state it here. |
26 | #needs_sphinx = '1.0' |
27 | |
28 | # Add any Sphinx extension module names here, as strings. They can be |
29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
30 | # ones. |
31 | extensions = [] |
32 | |
33 | # Add any paths that contain templates here, relative to this directory. |
34 | templates_path = ['_templates'] |
35 | |
36 | # The suffix of source filenames. |
37 | source_suffix = '.rst' |
38 | |
39 | # The encoding of source files. |
40 | #source_encoding = 'utf-8-sig' |
41 | |
42 | # The master toctree document. |
43 | master_doc = 'index' |
44 | |
45 | # General information about the project. |
46 | project = u'Rainbow Stream' |
47 | copyright = u'2014, Vu Nhat Minh' |
48 | |
49 | # The version info for the project you're documenting, acts as replacement for |
50 | # |version| and |release|, also used in various other places throughout the |
51 | # built documents. |
52 | # |
53 | # The short X.Y version. |
997c0570 |
54 | version = '0.4.3' |
c264071c |
55 | # The full version, including alpha/beta/rc tags. |
997c0570 |
56 | release = '0.4.3' |
c264071c |
57 | |
58 | # The language for content autogenerated by Sphinx. Refer to documentation |
59 | # for a list of supported languages. |
60 | #language = None |
61 | |
62 | # There are two options for replacing |today|: either, you set today to some |
63 | # non-false value, then it is used: |
64 | #today = '' |
65 | # Else, today_fmt is used as the format for a strftime call. |
66 | #today_fmt = '%B %d, %Y' |
67 | |
68 | # List of patterns, relative to source directory, that match files and |
69 | # directories to ignore when looking for source files. |
70 | exclude_patterns = ['_build'] |
71 | |
72 | # The reST default role (used for this markup: `text`) to use for all |
73 | # 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 | # If true, keep warnings as "system message" paragraphs in the built documents. |
94 | #keep_warnings = False |
95 | |
96 | |
97 | # -- Options for HTML output ---------------------------------------------- |
98 | |
99 | # The theme to use for HTML and HTML Help pages. See the documentation for |
100 | # a list of builtin themes. |
997c0570 |
101 | sys.path.append(os.path.abspath('_themes')) |
102 | html_theme_path = ['_themes'] |
103 | html_theme = 'flask' |
c264071c |
104 | |
105 | # Theme options are theme-specific and customize the look and feel of a theme |
106 | # further. For a list of options available for each theme, see the |
107 | # documentation. |
108 | #html_theme_options = {} |
109 | |
110 | # Add any paths that contain custom themes here, relative to this directory. |
111 | #html_theme_path = [] |
112 | |
113 | # The name for this set of Sphinx documents. If None, it defaults to |
114 | # "<project> v<release> documentation". |
115 | #html_title = None |
116 | |
117 | # A shorter title for the navigation bar. Default is the same as html_title. |
118 | #html_short_title = None |
119 | |
120 | # The name of an image file (relative to this directory) to place at the top |
121 | # of the sidebar. |
122 | #html_logo = None |
123 | |
124 | # The name of an image file (within the static path) to use as favicon of the |
125 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
126 | # pixels large. |
127 | #html_favicon = None |
128 | |
129 | # Add any paths that contain custom static files (such as style sheets) here, |
130 | # relative to this directory. They are copied after the builtin static files, |
131 | # so a file named "default.css" will overwrite the builtin "default.css". |
132 | html_static_path = ['_static'] |
133 | |
134 | # Add any extra paths that contain custom files (such as robots.txt or |
135 | # .htaccess) here, relative to this directory. These files are copied |
136 | # directly to the root of the documentation. |
137 | #html_extra_path = [] |
138 | |
139 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
140 | # using the given strftime format. |
141 | #html_last_updated_fmt = '%b %d, %Y' |
142 | |
143 | # If true, SmartyPants will be used to convert quotes and dashes to |
144 | # typographically correct entities. |
145 | #html_use_smartypants = True |
146 | |
147 | # Custom sidebar templates, maps document names to template names. |
148 | #html_sidebars = {} |
149 | |
150 | # Additional templates that should be rendered to pages, maps page names to |
151 | # template names. |
152 | #html_additional_pages = {} |
153 | |
154 | # If false, no module index is generated. |
155 | #html_domain_indices = True |
156 | |
157 | # If false, no index is generated. |
158 | #html_use_index = True |
159 | |
160 | # If true, the index is split into individual pages for each letter. |
161 | #html_split_index = False |
162 | |
163 | # If true, links to the reST sources are added to the pages. |
164 | #html_show_sourcelink = True |
165 | |
166 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
167 | #html_show_sphinx = True |
168 | |
169 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
170 | #html_show_copyright = True |
171 | |
172 | # If true, an OpenSearch description file will be output, and all pages will |
173 | # contain a <link> tag referring to it. The value of this option must be the |
174 | # base URL from which the finished HTML is served. |
175 | #html_use_opensearch = '' |
176 | |
177 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
178 | #html_file_suffix = None |
179 | |
180 | # Output file base name for HTML help builder. |
181 | htmlhelp_basename = 'RainbowStreamdoc' |
182 | |
183 | |
184 | # -- Options for LaTeX output --------------------------------------------- |
185 | |
186 | latex_elements = { |
187 | # The paper size ('letterpaper' or 'a4paper'). |
188 | #'papersize': 'letterpaper', |
189 | |
190 | # The font size ('10pt', '11pt' or '12pt'). |
191 | #'pointsize': '10pt', |
192 | |
193 | # Additional stuff for the LaTeX preamble. |
194 | #'preamble': '', |
195 | } |
196 | |
197 | # Grouping the document tree into LaTeX files. List of tuples |
198 | # (source start file, target name, title, |
199 | # author, documentclass [howto, manual, or own class]). |
200 | latex_documents = [ |
201 | ('index', 'RainbowStream.tex', u'Rainbow Stream Documentation', |
202 | u'Vu Nhat Minh', 'manual'), |
203 | ] |
204 | |
205 | # The name of an image file (relative to this directory) to place at the top of |
206 | # the title page. |
207 | #latex_logo = None |
208 | |
209 | # For "manual" documents, if this is true, then toplevel headings are parts, |
210 | # not chapters. |
211 | #latex_use_parts = False |
212 | |
213 | # If true, show page references after internal links. |
214 | #latex_show_pagerefs = False |
215 | |
216 | # If true, show URL addresses after external links. |
217 | #latex_show_urls = False |
218 | |
219 | # Documents to append as an appendix to all manuals. |
220 | #latex_appendices = [] |
221 | |
222 | # If false, no module index is generated. |
223 | #latex_domain_indices = True |
224 | |
225 | |
226 | # -- Options for manual page output --------------------------------------- |
227 | |
228 | # One entry per manual page. List of tuples |
229 | # (source start file, name, description, authors, manual section). |
230 | man_pages = [ |
231 | ('index', 'rainbowstream', u'Rainbow Stream Documentation', |
232 | [u'Vu Nhat Minh'], 1) |
233 | ] |
234 | |
235 | # If true, show URL addresses after external links. |
236 | #man_show_urls = False |
237 | |
238 | |
239 | # -- Options for Texinfo output ------------------------------------------- |
240 | |
241 | # Grouping the document tree into Texinfo files. List of tuples |
242 | # (source start file, target name, title, author, |
243 | # dir menu entry, description, category) |
244 | texinfo_documents = [ |
245 | ('index', 'RainbowStream', u'Rainbow Stream Documentation', |
246 | u'Vu Nhat Minh', 'RainbowStream', 'One line description of project.', |
247 | 'Miscellaneous'), |
248 | ] |
249 | |
250 | # Documents to append as an appendix to all manuals. |
251 | #texinfo_appendices = [] |
252 | |
253 | # If false, no module index is generated. |
254 | #texinfo_domain_indices = True |
255 | |
256 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
257 | #texinfo_show_urls = 'footnote' |
258 | |
259 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
260 | #texinfo_no_detailmenu = False |