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