|
11 | 11 | # All configuration values have a default; values that are commented out |
12 | 12 | # serve to show the default. |
13 | 13 |
|
14 | | -import sys, os |
| 14 | +import sys |
15 | 15 |
|
16 | 16 | # If extensions (or modules to document with autodoc) are in another directory, |
17 | 17 | # add these directories to sys.path here. If the directory is relative to the |
18 | 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
19 | | -#sys.path.insert(0, os.path.abspath('.')) |
20 | | -#sys.path.append("..") |
| 19 | +# sys.path.insert(0, os.path.abspath('.')) |
| 20 | +# sys.path.append("..") |
21 | 21 | # Use path in the SDK. Hence need to override system package path by inserting |
22 | 22 | # to position 0. |
23 | 23 | sys.path.insert(0, "..") |
24 | 24 |
|
25 | 25 | # -- General configuration ----------------------------------------------------- |
26 | 26 |
|
27 | 27 | # If your documentation needs a minimal Sphinx version, state it here. |
28 | | -#needs_sphinx = '1.0' |
| 28 | +# needs_sphinx = '1.0' |
29 | 29 |
|
30 | 30 | # Add any Sphinx extension module names here, as strings. They can be extensions |
31 | 31 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
38 | 38 | source_suffix = '.rst' |
39 | 39 |
|
40 | 40 | # The encoding of source files. |
41 | | -#source_encoding = 'utf-8-sig' |
| 41 | +# source_encoding = 'utf-8-sig' |
42 | 42 |
|
43 | 43 | # The master toctree document. |
44 | 44 | master_doc = 'index' |
|
54 | 54 | # The short X.Y version. |
55 | 55 | version = '0.9' |
56 | 56 | # The full version, including alpha/beta/rc tags. |
57 | | -release = '0.9.2' |
| 57 | +release = '0.9.6' |
58 | 58 |
|
59 | 59 | # The language for content autogenerated by Sphinx. Refer to documentation |
60 | 60 | # for a list of supported languages. |
61 | | -#language = None |
| 61 | +# language = None |
62 | 62 |
|
63 | 63 | # There are two options for replacing |today|: either, you set today to some |
64 | 64 | # non-false value, then it is used: |
65 | | -#today = '' |
| 65 | +# today = '' |
66 | 66 | # Else, today_fmt is used as the format for a strftime call. |
67 | | -#today_fmt = '%B %d, %Y' |
| 67 | +# today_fmt = '%B %d, %Y' |
68 | 68 |
|
69 | 69 | # List of patterns, relative to source directory, that match files and |
70 | 70 | # directories to ignore when looking for source files. |
71 | 71 | exclude_patterns = [] |
72 | 72 |
|
73 | 73 | # The reST default role (used for this markup: `text`) to use for all documents. |
74 | | -#default_role = None |
| 74 | +# default_role = None |
75 | 75 |
|
76 | 76 | # If true, '()' will be appended to :func: etc. cross-reference text. |
77 | | -#add_function_parentheses = True |
| 77 | +# add_function_parentheses = True |
78 | 78 |
|
79 | 79 | # If true, the current module name will be prepended to all description |
80 | 80 | # unit titles (such as .. function::). |
81 | | -#add_module_names = True |
| 81 | +# add_module_names = True |
82 | 82 |
|
83 | 83 | # If true, sectionauthor and moduleauthor directives will be shown in the |
84 | 84 | # output. They are ignored by default. |
85 | | -#show_authors = False |
| 85 | +# show_authors = False |
86 | 86 |
|
87 | 87 | # The name of the Pygments (syntax highlighting) style to use. |
88 | 88 | pygments_style = 'sphinx' |
89 | 89 |
|
90 | 90 | # A list of ignored prefixes for module index sorting. |
91 | | -#modindex_common_prefix = [] |
| 91 | +# modindex_common_prefix = [] |
92 | 92 |
|
93 | 93 |
|
94 | 94 | # -- Options for HTML output --------------------------------------------------- |
|
100 | 100 | # Theme options are theme-specific and customize the look and feel of a theme |
101 | 101 | # further. For a list of options available for each theme, see the |
102 | 102 | # documentation. |
103 | | -#html_theme_options = {} |
| 103 | +# html_theme_options = {} |
104 | 104 |
|
105 | 105 | # Add any paths that contain custom themes here, relative to this directory. |
106 | | -#html_theme_path = [] |
| 106 | +# html_theme_path = [] |
107 | 107 |
|
108 | 108 | # The name for this set of Sphinx documents. If None, it defaults to |
109 | 109 | # "<project> v<release> documentation". |
110 | | -#html_title = None |
| 110 | +# html_title = None |
111 | 111 |
|
112 | 112 | # A shorter title for the navigation bar. Default is the same as html_title. |
113 | | -#html_short_title = None |
| 113 | +# html_short_title = None |
114 | 114 |
|
115 | 115 | # The name of an image file (relative to this directory) to place at the top |
116 | 116 | # of the sidebar. |
117 | | -#html_logo = None |
| 117 | +# html_logo = None |
118 | 118 |
|
119 | 119 | # The name of an image file (within the static path) to use as favicon of the |
120 | 120 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
121 | 121 | # pixels large. |
122 | | -#html_favicon = None |
| 122 | +# html_favicon = None |
123 | 123 |
|
124 | 124 | # Add any paths that contain custom static files (such as style sheets) here, |
125 | 125 | # relative to this directory. They are copied after the builtin static files, |
126 | 126 | # so a file named "default.css" will overwrite the builtin "default.css". |
127 | | -#html_static_path = ['_static'] |
| 127 | +# html_static_path = ['_static'] |
128 | 128 |
|
129 | 129 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
130 | 130 | # using the given strftime format. |
131 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 131 | +# html_last_updated_fmt = '%b %d, %Y' |
132 | 132 |
|
133 | 133 | # If true, SmartyPants will be used to convert quotes and dashes to |
134 | 134 | # typographically correct entities. |
135 | | -#html_use_smartypants = True |
| 135 | +# html_use_smartypants = True |
136 | 136 |
|
137 | 137 | # Custom sidebar templates, maps document names to template names. |
138 | | -#html_sidebars = {} |
| 138 | +# html_sidebars = {} |
139 | 139 |
|
140 | 140 | # Additional templates that should be rendered to pages, maps page names to |
141 | 141 | # template names. |
142 | | -#html_additional_pages = {} |
| 142 | +# html_additional_pages = {} |
143 | 143 |
|
144 | 144 | # If false, no module index is generated. |
145 | | -#html_domain_indices = True |
| 145 | +# html_domain_indices = True |
146 | 146 |
|
147 | 147 | # If false, no index is generated. |
148 | | -#html_use_index = True |
| 148 | +# html_use_index = True |
149 | 149 |
|
150 | 150 | # If true, the index is split into individual pages for each letter. |
151 | | -#html_split_index = False |
| 151 | +# html_split_index = False |
152 | 152 |
|
153 | 153 | # If true, links to the reST sources are added to the pages. |
154 | | -#html_show_sourcelink = True |
| 154 | +# html_show_sourcelink = True |
155 | 155 |
|
156 | 156 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
157 | | -#html_show_sphinx = True |
| 157 | +# html_show_sphinx = True |
158 | 158 |
|
159 | 159 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
160 | | -#html_show_copyright = True |
| 160 | +# html_show_copyright = True |
161 | 161 |
|
162 | 162 | # If true, an OpenSearch description file will be output, and all pages will |
163 | 163 | # contain a <link> tag referring to it. The value of this option must be the |
164 | 164 | # base URL from which the finished HTML is served. |
165 | | -#html_use_opensearch = '' |
| 165 | +# html_use_opensearch = '' |
166 | 166 |
|
167 | 167 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
168 | | -#html_file_suffix = None |
| 168 | +# html_file_suffix = None |
169 | 169 |
|
170 | 170 | # Output file base name for HTML help builder. |
171 | 171 | htmlhelp_basename = 'PredictionIO-Python-SDKdoc' |
|
174 | 174 | # -- Options for LaTeX output -------------------------------------------------- |
175 | 175 |
|
176 | 176 | latex_elements = { |
177 | | -# The paper size ('letterpaper' or 'a4paper'). |
178 | | -#'papersize': 'letterpaper', |
| 177 | + # The paper size ('letterpaper' or 'a4paper'). |
| 178 | + # 'papersize': 'letterpaper', |
179 | 179 |
|
180 | | -# The font size ('10pt', '11pt' or '12pt'). |
181 | | -#'pointsize': '10pt', |
| 180 | + # The font size ('10pt', '11pt' or '12pt'). |
| 181 | + # 'pointsize': '10pt', |
182 | 182 |
|
183 | | -# Additional stuff for the LaTeX preamble. |
184 | | -#'preamble': '', |
| 183 | + # Additional stuff for the LaTeX preamble. |
| 184 | + # 'preamble': '', |
185 | 185 | } |
186 | 186 |
|
187 | 187 | # Grouping the document tree into LaTeX files. List of tuples |
188 | 188 | # (source start file, target name, title, author, documentclass [howto/manual]). |
189 | 189 | latex_documents = [ |
190 | | - ('index', 'PredictionIO-Python-SDK.tex', u'PredictionIO-Python-SDK Documentation', |
191 | | - u'TappingStone', 'manual'), |
| 190 | + ('index', 'PredictionIO-Python-SDK.tex', u'PredictionIO-Python-SDK Documentation', |
| 191 | + u'TappingStone', 'manual'), |
192 | 192 | ] |
193 | 193 |
|
194 | 194 | # The name of an image file (relative to this directory) to place at the top of |
195 | 195 | # the title page. |
196 | | -#latex_logo = None |
| 196 | +# latex_logo = None |
197 | 197 |
|
198 | 198 | # For "manual" documents, if this is true, then toplevel headings are parts, |
199 | 199 | # not chapters. |
200 | | -#latex_use_parts = False |
| 200 | +# latex_use_parts = False |
201 | 201 |
|
202 | 202 | # If true, show page references after internal links. |
203 | | -#latex_show_pagerefs = False |
| 203 | +# latex_show_pagerefs = False |
204 | 204 |
|
205 | 205 | # If true, show URL addresses after external links. |
206 | | -#latex_show_urls = False |
| 206 | +# latex_show_urls = False |
207 | 207 |
|
208 | 208 | # Documents to append as an appendix to all manuals. |
209 | | -#latex_appendices = [] |
| 209 | +# latex_appendices = [] |
210 | 210 |
|
211 | 211 | # If false, no module index is generated. |
212 | | -#latex_domain_indices = True |
| 212 | +# latex_domain_indices = True |
213 | 213 |
|
214 | 214 |
|
215 | 215 | # -- Options for manual page output -------------------------------------------- |
|
222 | 222 | ] |
223 | 223 |
|
224 | 224 | # If true, show URL addresses after external links. |
225 | | -#man_show_urls = False |
| 225 | +# man_show_urls = False |
226 | 226 |
|
227 | 227 |
|
228 | 228 | # -- Options for Texinfo output ------------------------------------------------ |
229 | 229 |
|
230 | 230 | # Grouping the document tree into Texinfo files. List of tuples |
231 | 231 | # (source start file, target name, title, author, |
232 | | -# dir menu entry, description, category) |
| 232 | +# dir menu entry, description, category) |
233 | 233 | texinfo_documents = [ |
234 | | - ('index', 'PredictionIO-Python-SDK', u'PredictionIO-Python-SDK Documentation', |
235 | | - u'TappingStone', 'PredictionIO-Python-SDK', 'One line description of project.', |
236 | | - 'Miscellaneous'), |
| 234 | + ('index', 'PredictionIO-Python-SDK', u'PredictionIO-Python-SDK Documentation', |
| 235 | + u'TappingStone', 'PredictionIO-Python-SDK', 'One line description of project.', |
| 236 | + 'Miscellaneous'), |
237 | 237 | ] |
238 | 238 |
|
239 | 239 | # Documents to append as an appendix to all manuals. |
240 | | -#texinfo_appendices = [] |
| 240 | +# texinfo_appendices = [] |
241 | 241 |
|
242 | 242 | # If false, no module index is generated. |
243 | | -#texinfo_domain_indices = True |
| 243 | +# texinfo_domain_indices = True |
244 | 244 |
|
245 | 245 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
246 | | -#texinfo_show_urls = 'footnote' |
| 246 | +# texinfo_show_urls = 'footnote' |
247 | 247 |
|
248 | 248 | autodoc_member_order = 'bysource' |
0 commit comments