|
22 | 22 | # -- General configuration ----------------------------------------------------- |
23 | 23 |
|
24 | 24 | # If your documentation needs a minimal Sphinx version, state it here. |
25 | | -#needs_sphinx = '1.0' |
| 25 | +# needs_sphinx = '1.0' |
26 | 26 |
|
27 | 27 | # Add any Sphinx extension module names here, as strings. They can be extensions |
28 | 28 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
35 | 35 | source_suffix = '.rst' |
36 | 36 |
|
37 | 37 | # The encoding of source files. |
38 | | -#source_encoding = 'utf-8-sig' |
| 38 | +# source_encoding = 'utf-8-sig' |
39 | 39 |
|
40 | 40 | # The master toctree document. |
41 | 41 | master_doc = 'index' |
|
57 | 57 |
|
58 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation |
59 | 59 | # for a list of supported languages. |
60 | | -#language = None |
| 60 | +# language = None |
61 | 61 |
|
62 | 62 | # There are two options for replacing |today|: either, you set today to some |
63 | 63 | # non-false value, then it is used: |
64 | | -#today = '' |
| 64 | +# today = '' |
65 | 65 | # Else, today_fmt is used as the format for a strftime call. |
66 | | -#today_fmt = '%B %d, %Y' |
| 66 | +# today_fmt = '%B %d, %Y' |
67 | 67 |
|
68 | 68 | # List of patterns, relative to source directory, that match files and |
69 | 69 | # directories to ignore when looking for source files. |
70 | 70 | exclude_patterns = ['_build'] |
71 | 71 |
|
72 | 72 | # The reST default role (used for this markup: `text`) to use for all documents. |
73 | | -#default_role = None |
| 73 | +# default_role = None |
74 | 74 |
|
75 | 75 | # If true, '()' will be appended to :func: etc. cross-reference text. |
76 | | -#add_function_parentheses = True |
| 76 | +# add_function_parentheses = True |
77 | 77 |
|
78 | 78 | # If true, the current module name will be prepended to all description |
79 | 79 | # unit titles (such as .. function::). |
80 | | -#add_module_names = True |
| 80 | +# add_module_names = True |
81 | 81 |
|
82 | 82 | # If true, sectionauthor and moduleauthor directives will be shown in the |
83 | 83 | # output. They are ignored by default. |
84 | | -#show_authors = False |
| 84 | +# show_authors = False |
85 | 85 |
|
86 | 86 | # The name of the Pygments (syntax highlighting) style to use. |
87 | 87 | pygments_style = 'friendly' |
88 | 88 |
|
89 | 89 | # A list of ignored prefixes for module index sorting. |
90 | | -#modindex_common_prefix = [] |
| 90 | +# modindex_common_prefix = [] |
91 | 91 |
|
92 | 92 |
|
93 | 93 | # -- Options for HTML output --------------------------------------------------- |
|
104 | 104 | # Theme options are theme-specific and customize the look and feel of a theme |
105 | 105 | # further. For a list of options available for each theme, see the |
106 | 106 | # documentation. |
107 | | -#html_theme_options = {} |
| 107 | +# html_theme_options = {} |
108 | 108 |
|
109 | 109 | # Add any paths that contain custom themes here, relative to this directory. |
110 | | -#html_theme_path = [] |
| 110 | +# html_theme_path = [] |
111 | 111 |
|
112 | 112 | # The name for this set of Sphinx documents. If None, it defaults to |
113 | 113 | # "<project> v<release> documentation". |
114 | | -#html_title = None |
| 114 | +# html_title = None |
115 | 115 |
|
116 | 116 | # A shorter title for the navigation bar. Default is the same as html_title. |
117 | | -#html_short_title = None |
| 117 | +# html_short_title = None |
118 | 118 |
|
119 | 119 | # The name of an image file (relative to this directory) to place at the top |
120 | 120 | # of the sidebar. |
121 | | -#html_logo = None |
| 121 | +# html_logo = None |
122 | 122 |
|
123 | 123 | # The name of an image file (within the static path) to use as favicon of the |
124 | 124 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
125 | 125 | # pixels large. |
126 | | -#html_favicon = None |
| 126 | +# html_favicon = None |
127 | 127 |
|
128 | 128 | # Add any paths that contain custom static files (such as style sheets) here, |
129 | 129 | # relative to this directory. They are copied after the builtin static files, |
|
132 | 132 |
|
133 | 133 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
134 | 134 | # using the given strftime format. |
135 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 135 | +# html_last_updated_fmt = '%b %d, %Y' |
136 | 136 |
|
137 | 137 | # If true, SmartyPants will be used to convert quotes and dashes to |
138 | 138 | # typographically correct entities. |
139 | | -#html_use_smartypants = True |
| 139 | +# html_use_smartypants = True |
140 | 140 |
|
141 | 141 | # Custom sidebar templates, maps document names to template names. |
142 | | -#html_sidebars = {} |
| 142 | +# html_sidebars = {} |
143 | 143 |
|
144 | 144 | # Additional templates that should be rendered to pages, maps page names to |
145 | 145 | # template names. |
146 | | -#html_additional_pages = {} |
| 146 | +# html_additional_pages = {} |
147 | 147 |
|
148 | 148 | # If false, no module index is generated. |
149 | | -#html_domain_indices = True |
| 149 | +# html_domain_indices = True |
150 | 150 |
|
151 | 151 | # If false, no index is generated. |
152 | | -#html_use_index = True |
| 152 | +# html_use_index = True |
153 | 153 |
|
154 | 154 | # If true, the index is split into individual pages for each letter. |
155 | | -#html_split_index = False |
| 155 | +# html_split_index = False |
156 | 156 |
|
157 | 157 | # If true, links to the reST sources are added to the pages. |
158 | | -#html_show_sourcelink = True |
| 158 | +# html_show_sourcelink = True |
159 | 159 |
|
160 | 160 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
161 | | -#html_show_sphinx = True |
| 161 | +# html_show_sphinx = True |
162 | 162 |
|
163 | 163 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
164 | | -#html_show_copyright = True |
| 164 | +# html_show_copyright = True |
165 | 165 |
|
166 | 166 | # If true, an OpenSearch description file will be output, and all pages will |
167 | 167 | # contain a <link> tag referring to it. The value of this option must be the |
168 | 168 | # base URL from which the finished HTML is served. |
169 | | -#html_use_opensearch = '' |
| 169 | +# html_use_opensearch = '' |
170 | 170 |
|
171 | 171 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
172 | | -#html_file_suffix = None |
| 172 | +# html_file_suffix = None |
173 | 173 |
|
174 | 174 | # Output file base name for HTML help builder. |
175 | 175 | htmlhelp_basename = 'SoftLayerAPIPythonClientdoc' |
|
179 | 179 |
|
180 | 180 | latex_elements = { |
181 | 181 | # The paper size ('letterpaper' or 'a4paper'). |
182 | | -#'papersize': 'letterpaper', |
| 182 | +# 'papersize': 'letterpaper', |
183 | 183 |
|
184 | 184 | # The font size ('10pt', '11pt' or '12pt'). |
185 | | -#'pointsize': '10pt', |
| 185 | +# 'pointsize': '10pt', |
186 | 186 |
|
187 | 187 | # Additional stuff for the LaTeX preamble. |
188 | | -#'preamble': '', |
| 188 | +# 'preamble': '', |
189 | 189 | } |
190 | 190 |
|
191 | 191 | # Grouping the document tree into LaTeX files. List of tuples |
|
197 | 197 |
|
198 | 198 | # The name of an image file (relative to this directory) to place at the top of |
199 | 199 | # the title page. |
200 | | -#latex_logo = None |
| 200 | +# latex_logo = None |
201 | 201 |
|
202 | 202 | # For "manual" documents, if this is true, then toplevel headings are parts, |
203 | 203 | # not chapters. |
204 | | -#latex_use_parts = False |
| 204 | +# latex_use_parts = False |
205 | 205 |
|
206 | 206 | # If true, show page references after internal links. |
207 | | -#latex_show_pagerefs = False |
| 207 | +# latex_show_pagerefs = False |
208 | 208 |
|
209 | 209 | # If true, show URL addresses after external links. |
210 | | -#latex_show_urls = False |
| 210 | +# latex_show_urls = False |
211 | 211 |
|
212 | 212 | # Documents to append as an appendix to all manuals. |
213 | | -#latex_appendices = [] |
| 213 | +# latex_appendices = [] |
214 | 214 |
|
215 | 215 | # If false, no module index is generated. |
216 | | -#latex_domain_indices = True |
| 216 | +# latex_domain_indices = True |
217 | 217 |
|
218 | 218 |
|
219 | 219 | # -- Options for manual page output -------------------------------------------- |
|
226 | 226 | ] |
227 | 227 |
|
228 | 228 | # If true, show URL addresses after external links. |
229 | | -#man_show_urls = False |
| 229 | +# man_show_urls = False |
230 | 230 |
|
231 | 231 |
|
232 | 232 | # -- Options for Texinfo output ------------------------------------------------ |
|
241 | 241 | ] |
242 | 242 |
|
243 | 243 | # Documents to append as an appendix to all manuals. |
244 | | -#texinfo_appendices = [] |
| 244 | +# texinfo_appendices = [] |
245 | 245 |
|
246 | 246 | # If false, no module index is generated. |
247 | | -#texinfo_domain_indices = True |
| 247 | +# texinfo_domain_indices = True |
248 | 248 |
|
249 | 249 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
250 | | -#texinfo_show_urls = 'footnote' |
| 250 | +# texinfo_show_urls = 'footnote' |
0 commit comments