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