1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
#!/usr/bin/env python3
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
version_file = os.path.join(os.path.dirname(os.path.dirname(__file__)),
'asyncpg', '_version.py')
with open(version_file, 'r') as f:
for line in f:
if line.startswith('__version__: typing.Final ='):
_, _, version = line.partition('=')
version = version.strip(" \n'\"")
break
else:
raise RuntimeError(
'unable to read the version from asyncpg/_version.py')
# -- General configuration ------------------------------------------------
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx.ext.intersphinx',
]
add_module_names = False
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = 'asyncpg'
copyright = '2016-present, the asyncpg authors and contributors'
author = '<See AUTHORS file>'
release = version
language = "en"
exclude_patterns = ['_build']
pygments_style = 'sphinx'
todo_include_todos = False
suppress_warnings = ['image.nonlocal_uri']
# -- Options for HTML output ----------------------------------------------
html_theme = 'sphinx_rtd_theme'
html_title = 'asyncpg Documentation'
html_short_title = 'asyncpg'
html_static_path = ['_static']
html_sidebars = {
'**': [
'about.html',
'navigation.html',
]
}
html_show_sourcelink = False
html_show_sphinx = False
html_show_copyright = True
htmlhelp_basename = 'asyncpgdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {}
latex_documents = [
(master_doc, 'asyncpg.tex', 'asyncpg Documentation',
author, 'manual'),
]
# -- Options for manual page output ---------------------------------------
man_pages = [
(master_doc, 'asyncpg', 'asyncpg Documentation',
[author], 1)
]
# -- Options for Texinfo output -------------------------------------------
texinfo_documents = [
(master_doc, 'asyncpg', 'asyncpg Documentation',
author, 'asyncpg',
'asyncpg is a fast PostgreSQL client library for the '
'Python asyncio framework',
'Miscellaneous'),
]
# -- Options for intersphinx ----------------------------------------------
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
|
