1
|
|
|
#!/usr/bin/env python3 |
2
|
|
|
# -*- coding: utf-8 -*- |
3
|
|
|
# |
4
|
|
|
# goblin documentation build configuration file, created by |
5
|
|
|
# sphinx-quickstart on Sat Jul 16 14:01:32 2016. |
6
|
|
|
# |
7
|
|
|
# This file is execfile()d with the current directory set to its |
8
|
|
|
# containing dir. |
9
|
|
|
# |
10
|
|
|
# Note that not all possible configuration values are present in this |
11
|
|
|
# autogenerated file. |
12
|
|
|
# |
13
|
|
|
# All configuration values have a default; values that are commented out |
14
|
|
|
# serve to show the default. |
15
|
|
|
|
16
|
|
|
# If extensions (or modules to document with autodoc) are in another directory, |
17
|
|
|
# add these directories to sys.path here. If the directory is relative to the |
18
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here. |
19
|
|
|
# |
20
|
|
|
|
21
|
|
|
import os |
22
|
|
|
import shlex |
23
|
|
|
import sys |
24
|
|
|
|
25
|
|
|
import alabaster |
26
|
|
|
|
27
|
|
|
sys.path.insert(0, os.path.dirname(os.path.dirname(__file__))) |
28
|
|
|
|
29
|
|
|
# -- General configuration ------------------------------------------------ |
30
|
|
|
|
31
|
|
|
# If your documentation needs a minimal Sphinx version, state it here. |
32
|
|
|
# |
33
|
|
|
# needs_sphinx = '1.0' |
34
|
|
|
|
35
|
|
|
# Add any Sphinx extension module names here, as strings. They can be |
36
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
37
|
|
|
# ones. |
38
|
|
|
extensions = [ |
39
|
|
|
'sphinx.ext.autodoc', |
40
|
|
|
'sphinx.ext.intersphinx', |
41
|
|
|
'sphinx.ext.viewcode', |
42
|
|
|
'alabaster', |
43
|
|
|
] |
44
|
|
|
|
45
|
|
|
# Add any paths that contain templates here, relative to this directory. |
46
|
|
|
templates_path = ['_templates'] |
47
|
|
|
|
48
|
|
|
# The suffix(es) of source filenames. |
49
|
|
|
# You can specify multiple suffix as a list of string: |
50
|
|
|
# |
51
|
|
|
# source_suffix = ['.rst', '.md'] |
52
|
|
|
source_suffix = '.rst' |
53
|
|
|
|
54
|
|
|
# The encoding of source files. |
55
|
|
|
# |
56
|
|
|
# source_encoding = 'utf-8-sig' |
57
|
|
|
|
58
|
|
|
# The master toctree document. |
59
|
|
|
master_doc = 'index' |
60
|
|
|
|
61
|
|
|
# General information about the project. |
62
|
|
|
project = 'goblin' |
63
|
|
|
copyright = '2016, David M. Brown' |
64
|
|
|
author = 'David M. Brown' |
65
|
|
|
|
66
|
|
|
# The version info for the project you're documenting, acts as replacement for |
67
|
|
|
# |version| and |release|, also used in various other places throughout the |
68
|
|
|
# built documents. |
69
|
|
|
# |
70
|
|
|
# Get the version string. Cannot be done with import! |
71
|
|
|
g = {} |
72
|
|
|
with open(os.path.join(os.path.dirname(__file__), '..', |
73
|
|
|
'goblin', 'version.py'), |
74
|
|
|
'rt') as fp: |
75
|
|
|
exec(fp.read(), g) |
76
|
|
|
version = g['__version__'] |
77
|
|
|
|
78
|
|
|
# The full version, including alpha/beta/rc tags. |
79
|
|
|
release = version |
80
|
|
|
|
81
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation |
82
|
|
|
# for a list of supported languages. |
83
|
|
|
# |
84
|
|
|
# This is also used if you do content translation via gettext catalogs. |
85
|
|
|
# Usually you set "language" from the command line for these cases. |
86
|
|
|
language = None |
87
|
|
|
|
88
|
|
|
# There are two options for replacing |today|: either, you set today to some |
89
|
|
|
# non-false value, then it is used: |
90
|
|
|
# |
91
|
|
|
# today = '' |
92
|
|
|
# |
93
|
|
|
# Else, today_fmt is used as the format for a strftime call. |
94
|
|
|
# |
95
|
|
|
# today_fmt = '%B %d, %Y' |
96
|
|
|
|
97
|
|
|
# List of patterns, relative to source directory, that match files and |
98
|
|
|
# directories to ignore when looking for source files. |
99
|
|
|
# This patterns also effect to html_static_path and html_extra_path |
100
|
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
101
|
|
|
|
102
|
|
|
# The reST default role (used for this markup: `text`) to use for all |
103
|
|
|
# documents. |
104
|
|
|
# |
105
|
|
|
# default_role = None |
106
|
|
|
|
107
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text. |
108
|
|
|
# |
109
|
|
|
# add_function_parentheses = True |
110
|
|
|
|
111
|
|
|
# If true, the current module name will be prepended to all description |
112
|
|
|
# unit titles (such as .. function::). |
113
|
|
|
# |
114
|
|
|
# add_module_names = True |
115
|
|
|
|
116
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the |
117
|
|
|
# output. They are ignored by default. |
118
|
|
|
# |
119
|
|
|
# show_authors = False |
120
|
|
|
|
121
|
|
|
# The name of the Pygments (syntax highlighting) style to use. |
122
|
|
|
pygments_style = 'sphinx' |
123
|
|
|
|
124
|
|
|
# A list of ignored prefixes for module index sorting. |
125
|
|
|
# modindex_common_prefix = [] |
126
|
|
|
|
127
|
|
|
# If true, keep warnings as "system message" paragraphs in the built documents. |
128
|
|
|
# keep_warnings = False |
129
|
|
|
|
130
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing. |
131
|
|
|
todo_include_todos = False |
132
|
|
|
|
133
|
|
|
|
134
|
|
|
# -- Options for HTML output ---------------------------------------------- |
135
|
|
|
|
136
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for |
137
|
|
|
# a list of builtin themes. |
138
|
|
|
# |
139
|
|
|
html_theme = 'alabaster' |
140
|
|
|
|
141
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme |
142
|
|
|
# further. For a list of options available for each theme, see the |
143
|
|
|
# documentation. |
144
|
|
|
# |
145
|
|
|
html_theme_options = { |
146
|
|
|
# 'logo': 'logo.png', |
147
|
|
|
'description': 'Async Python toolkit for the TP3 Gremlin Server', |
148
|
|
|
'logo_text_align': 'left', |
149
|
|
|
'github_user': 'davebshow', |
150
|
|
|
'github_repo': 'goblin', |
151
|
|
|
'github_button': True, |
152
|
|
|
'github_banner': True, |
153
|
|
|
'travis_button': True |
154
|
|
|
} |
155
|
|
|
|
156
|
|
|
# Add any paths that contain custom themes here, relative to this directory. |
157
|
|
|
html_theme_path = [alabaster.get_path()] |
158
|
|
|
|
159
|
|
|
# The name for this set of Sphinx documents. |
160
|
|
|
# "<project> v<release> documentation" by default. |
161
|
|
|
# |
162
|
|
|
# html_title = 'goblin v0.1.1' |
163
|
|
|
|
164
|
|
|
# A shorter title for the navigation bar. Default is the same as html_title. |
165
|
|
|
# |
166
|
|
|
# html_short_title = None |
167
|
|
|
|
168
|
|
|
# The name of an image file (relative to this directory) to place at the top |
169
|
|
|
# of the sidebar. |
170
|
|
|
# |
171
|
|
|
# html_logo = None |
172
|
|
|
|
173
|
|
|
# The name of an image file (relative to this directory) to use as a favicon of |
174
|
|
|
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
175
|
|
|
# pixels large. |
176
|
|
|
# |
177
|
|
|
# html_favicon = None |
178
|
|
|
|
179
|
|
|
# Add any paths that contain custom static files (such as style sheets) here, |
180
|
|
|
# relative to this directory. They are copied after the builtin static files, |
181
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css". |
182
|
|
|
# html_static_path = ['_static'] |
183
|
|
|
|
184
|
|
|
# Add any extra paths that contain custom files (such as robots.txt or |
185
|
|
|
# .htaccess) here, relative to this directory. These files are copied |
186
|
|
|
# directly to the root of the documentation. |
187
|
|
|
# |
188
|
|
|
# html_extra_path = [] |
189
|
|
|
|
190
|
|
|
# If not None, a 'Last updated on:' timestamp is inserted at every page |
191
|
|
|
# bottom, using the given strftime format. |
192
|
|
|
# The empty string is equivalent to '%b %d, %Y'. |
193
|
|
|
# |
194
|
|
|
# html_last_updated_fmt = None |
195
|
|
|
|
196
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to |
197
|
|
|
# typographically correct entities. |
198
|
|
|
# |
199
|
|
|
# html_use_smartypants = True |
200
|
|
|
|
201
|
|
|
# Custom sidebar templates, maps document names to template names. |
202
|
|
|
# |
203
|
|
|
html_sidebars = { |
204
|
|
|
'**': [ |
205
|
|
|
'about.html', 'navigation.html', 'searchbox.html', 'donate.html', |
206
|
|
|
] |
207
|
|
|
} |
208
|
|
|
|
209
|
|
|
# Additional templates that should be rendered to pages, maps page names to |
210
|
|
|
# template names. |
211
|
|
|
# |
212
|
|
|
# html_additional_pages = {} |
213
|
|
|
|
214
|
|
|
# If false, no module index is generated. |
215
|
|
|
# |
216
|
|
|
# html_domain_indices = True |
217
|
|
|
|
218
|
|
|
# If false, no index is generated. |
219
|
|
|
# |
220
|
|
|
# html_use_index = True |
221
|
|
|
|
222
|
|
|
# If true, the index is split into individual pages for each letter. |
223
|
|
|
# |
224
|
|
|
# html_split_index = False |
225
|
|
|
|
226
|
|
|
# If true, links to the reST sources are added to the pages. |
227
|
|
|
# |
228
|
|
|
# html_show_sourcelink = True |
229
|
|
|
|
230
|
|
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
231
|
|
|
# |
232
|
|
|
# html_show_sphinx = True |
233
|
|
|
|
234
|
|
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
235
|
|
|
# |
236
|
|
|
# html_show_copyright = True |
237
|
|
|
|
238
|
|
|
# If true, an OpenSearch description file will be output, and all pages will |
239
|
|
|
# contain a <link> tag referring to it. The value of this option must be the |
240
|
|
|
# base URL from which the finished HTML is served. |
241
|
|
|
# |
242
|
|
|
# html_use_opensearch = '' |
243
|
|
|
|
244
|
|
|
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
245
|
|
|
# html_file_suffix = None |
246
|
|
|
|
247
|
|
|
# Language to be used for generating the HTML full-text search index. |
248
|
|
|
# Sphinx supports the following languages: |
249
|
|
|
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' |
250
|
|
|
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' |
251
|
|
|
# |
252
|
|
|
# html_search_language = 'en' |
253
|
|
|
|
254
|
|
|
# A dictionary with options for the search language support, empty by default. |
255
|
|
|
# 'ja' uses this config value. |
256
|
|
|
# 'zh' user can custom change `jieba` dictionary path. |
257
|
|
|
# |
258
|
|
|
# html_search_options = {'type': 'default'} |
259
|
|
|
|
260
|
|
|
# The name of a javascript file (relative to the configuration directory) that |
261
|
|
|
# implements a search results scorer. If empty, the default will be used. |
262
|
|
|
# |
263
|
|
|
# html_search_scorer = 'scorer.js' |
264
|
|
|
|
265
|
|
|
# Output file base name for HTML help builder. |
266
|
|
|
htmlhelp_basename = 'goblindoc' |
267
|
|
|
|
268
|
|
|
# -- Options for LaTeX output --------------------------------------------- |
269
|
|
|
|
270
|
|
|
latex_elements = { |
271
|
|
|
# The paper size ('letterpaper' or 'a4paper'). |
272
|
|
|
# |
273
|
|
|
# 'papersize': 'letterpaper', |
274
|
|
|
|
275
|
|
|
# The font size ('10pt', '11pt' or '12pt'). |
276
|
|
|
# |
277
|
|
|
# 'pointsize': '10pt', |
278
|
|
|
|
279
|
|
|
# Additional stuff for the LaTeX preamble. |
280
|
|
|
# |
281
|
|
|
# 'preamble': '', |
282
|
|
|
|
283
|
|
|
# Latex figure (float) alignment |
284
|
|
|
# |
285
|
|
|
# 'figure_align': 'htbp', |
286
|
|
|
} |
287
|
|
|
|
288
|
|
|
# Grouping the document tree into LaTeX files. List of tuples |
289
|
|
|
# (source start file, target name, title, |
290
|
|
|
# author, documentclass [howto, manual, or own class]). |
291
|
|
|
latex_documents = [ |
292
|
|
|
(master_doc, 'goblin.tex', 'goblin Documentation', |
293
|
|
|
'David M. Brown', 'manual'), |
294
|
|
|
] |
295
|
|
|
|
296
|
|
|
# The name of an image file (relative to this directory) to place at the top of |
297
|
|
|
# the title page. |
298
|
|
|
# |
299
|
|
|
# latex_logo = None |
300
|
|
|
|
301
|
|
|
# For "manual" documents, if this is true, then toplevel headings are parts, |
302
|
|
|
# not chapters. |
303
|
|
|
# |
304
|
|
|
# latex_use_parts = False |
305
|
|
|
|
306
|
|
|
# If true, show page references after internal links. |
307
|
|
|
# |
308
|
|
|
# latex_show_pagerefs = False |
309
|
|
|
|
310
|
|
|
# If true, show URL addresses after external links. |
311
|
|
|
# |
312
|
|
|
# latex_show_urls = False |
313
|
|
|
|
314
|
|
|
# Documents to append as an appendix to all manuals. |
315
|
|
|
# |
316
|
|
|
# latex_appendices = [] |
317
|
|
|
|
318
|
|
|
# It false, will not define \strong, \code, itleref, \crossref ... but only |
319
|
|
|
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added |
320
|
|
|
# packages. |
321
|
|
|
# |
322
|
|
|
# latex_keep_old_macro_names = True |
323
|
|
|
|
324
|
|
|
# If false, no module index is generated. |
325
|
|
|
# |
326
|
|
|
# latex_domain_indices = True |
327
|
|
|
|
328
|
|
|
|
329
|
|
|
# -- Options for manual page output --------------------------------------- |
330
|
|
|
|
331
|
|
|
# One entry per manual page. List of tuples |
332
|
|
|
# (source start file, name, description, authors, manual section). |
333
|
|
|
man_pages = [ |
334
|
|
|
(master_doc, 'goblin', 'goblin Documentation', |
335
|
|
|
[author], 1) |
336
|
|
|
] |
337
|
|
|
|
338
|
|
|
# If true, show URL addresses after external links. |
339
|
|
|
# |
340
|
|
|
# man_show_urls = False |
341
|
|
|
|
342
|
|
|
|
343
|
|
|
# -- Options for Texinfo output ------------------------------------------- |
344
|
|
|
|
345
|
|
|
# Grouping the document tree into Texinfo files. List of tuples |
346
|
|
|
# (source start file, target name, title, author, |
347
|
|
|
# dir menu entry, description, category) |
348
|
|
|
texinfo_documents = [ |
349
|
|
|
(master_doc, 'goblin', 'goblin Documentation', |
350
|
|
|
author, 'goblin', 'One line description of project.', |
351
|
|
|
'Miscellaneous'), |
352
|
|
|
] |
353
|
|
|
|
354
|
|
|
# Documents to append as an appendix to all manuals. |
355
|
|
|
# |
356
|
|
|
# texinfo_appendices = [] |
357
|
|
|
|
358
|
|
|
# If false, no module index is generated. |
359
|
|
|
# |
360
|
|
|
# texinfo_domain_indices = True |
361
|
|
|
|
362
|
|
|
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
363
|
|
|
# |
364
|
|
|
# texinfo_show_urls = 'footnote' |
365
|
|
|
|
366
|
|
|
# If true, do not generate a @detailmenu in the "Top" node's menu. |
367
|
|
|
# |
368
|
|
|
# texinfo_no_detailmenu = False |
369
|
|
|
|
370
|
|
|
|
371
|
|
|
# Example configuration for intersphinx: refer to the Python standard library. |
372
|
|
|
intersphinx_mapping = { |
373
|
|
|
'python': ('https://docs.python.org/3.6/', None), |
374
|
|
|
'aiohttp': ('https://aiohttp.readthedocs.org/en/stable/', None), |
375
|
|
|
'aiogremlin': ('https://aiogremlin.readthedocs.io/en/latest/', None), |
376
|
|
|
'cython': ('http://cython.readthedocs.io/en/latest/', None), |
377
|
|
|
} |
378
|
|
|
|