22
22
23
23
24
24
extensions = [
25
- ' sphinx.ext.autodoc' ,
26
- ' sphinx.ext.intersphinx' ,
27
- ' sphinx_autodoc_typehints' ,
28
- ' sphinx.ext.todo' ,
29
- ' sphinx.ext.linkcode' ,
30
- ' sphinx.ext.napoleon' ,
31
- ' alagitpull' ,
32
- ' sphinx_issues' ,
33
- ' myst_parser' ,
25
+ " sphinx.ext.autodoc" ,
26
+ " sphinx.ext.intersphinx" ,
27
+ " sphinx_autodoc_typehints" ,
28
+ " sphinx.ext.todo" ,
29
+ " sphinx.ext.linkcode" ,
30
+ " sphinx.ext.napoleon" ,
31
+ " alagitpull" ,
32
+ " sphinx_issues" ,
33
+ " myst_parser" ,
34
34
]
35
35
36
36
myst_enable_extensions = ["colon_fence" ]
37
37
38
- issues_github_path = about [' __github__' ].replace (' https://github.com/' , '' )
38
+ issues_github_path = about [" __github__" ].replace (" https://github.com/" , "" )
39
39
40
- templates_path = [' _templates' ]
40
+ templates_path = [" _templates" ]
41
41
42
- source_suffix = {' .rst' : ' restructuredtext' , ' .md' : ' markdown' }
42
+ source_suffix = {" .rst" : " restructuredtext" , " .md" : " markdown" }
43
43
44
- master_doc = ' index'
44
+ master_doc = " index"
45
45
46
- project = about [' __title__' ]
47
- copyright = about [' __copyright__' ]
46
+ project = about [" __title__" ]
47
+ copyright = about [" __copyright__" ]
48
48
49
- version = '%s' % ('.' .join (about [' __version__' ].split ('.' ))[:2 ])
50
- release = '%s' % (about [' __version__' ])
49
+ version = "%s" % ("." .join (about [" __version__" ].split ("." ))[:2 ])
50
+ release = "%s" % (about [" __version__" ])
51
51
52
- exclude_patterns = [' _build' ]
52
+ exclude_patterns = [" _build" ]
53
53
54
- pygments_style = ' sphinx'
54
+ pygments_style = " sphinx"
55
55
56
56
html_theme_path = [alagitpull .get_path ()]
57
- html_favicon = ' _static/favicon.ico'
58
- html_theme = ' alagitpull'
57
+ html_favicon = " _static/favicon.ico"
58
+ html_theme = " alagitpull"
59
59
html_theme_options = {
60
- ' logo' : ' img/libtmux.svg' ,
61
- ' github_user' : ' tmux-python' ,
62
- ' github_repo' : ' libtmux' ,
63
- ' github_type' : ' star' ,
64
- ' github_banner' : True ,
65
- ' projects' : alagitpull .projects ,
66
- ' project_name' : about [' __title__' ],
67
- ' project_title' : about [' __title__' ],
68
- ' project_description' : about [' __description__' ],
69
- ' project_url' : about [' __docs__' ],
70
- ' show_meta_manifest_tag' : True ,
71
- ' show_meta_og_tags' : True ,
72
- ' show_meta_app_icon_tags' : True ,
60
+ " logo" : " img/libtmux.svg" ,
61
+ " github_user" : " tmux-python" ,
62
+ " github_repo" : " libtmux" ,
63
+ " github_type" : " star" ,
64
+ " github_banner" : True ,
65
+ " projects" : alagitpull .projects ,
66
+ " project_name" : about [" __title__" ],
67
+ " project_title" : about [" __title__" ],
68
+ " project_description" : about [" __description__" ],
69
+ " project_url" : about [" __docs__" ],
70
+ " show_meta_manifest_tag" : True ,
71
+ " show_meta_og_tags" : True ,
72
+ " show_meta_app_icon_tags" : True ,
73
73
}
74
- alagitpull_internal_hosts = [' libtmux.git-pull.com' , ' 0.0.0.0' ]
74
+ alagitpull_internal_hosts = [" libtmux.git-pull.com" , " 0.0.0.0" ]
75
75
alagitpull_external_hosts_new_window = True
76
76
77
77
html_sidebars = {
78
- '**' : [
79
- ' about.html' ,
80
- ' navigation.html' ,
81
- ' relations.html' ,
82
- ' more.html' ,
83
- ' book.html' ,
84
- ' searchbox.html' ,
78
+ "**" : [
79
+ " about.html" ,
80
+ " navigation.html" ,
81
+ " relations.html" ,
82
+ " more.html" ,
83
+ " book.html" ,
84
+ " searchbox.html" ,
85
85
]
86
86
}
87
87
88
- html_theme_path = [' _themes' ]
89
- html_static_path = [' _static' ]
90
- html_extra_path = [' manifest.json' ]
88
+ html_theme_path = [" _themes" ]
89
+ html_static_path = [" _static" ]
90
+ html_extra_path = [" manifest.json" ]
91
91
92
- htmlhelp_basename = ' %sdoc' % about [' __title__' ]
92
+ htmlhelp_basename = " %sdoc" % about [" __title__" ]
93
93
94
94
latex_documents = [
95
95
(
96
- ' index' ,
97
- ' {}.tex' .format (about [' __package_name__' ]),
98
- ' {} Documentation' .format (about [' __title__' ]),
99
- about [' __author__' ],
100
- ' manual' ,
96
+ " index" ,
97
+ " {}.tex" .format (about [" __package_name__" ]),
98
+ " {} Documentation" .format (about [" __title__" ]),
99
+ about [" __author__" ],
100
+ " manual" ,
101
101
)
102
102
]
103
103
104
104
man_pages = [
105
105
(
106
- ' index' ,
107
- about [' __package_name__' ],
108
- ' {} Documentation' .format (about [' __title__' ]),
109
- about [' __author__' ],
106
+ " index" ,
107
+ about [" __package_name__" ],
108
+ " {} Documentation" .format (about [" __title__" ]),
109
+ about [" __author__" ],
110
110
1 ,
111
111
)
112
112
]
113
113
114
114
texinfo_documents = [
115
115
(
116
- ' index' ,
117
- '{}' .format (about [' __package_name__' ]),
118
- ' {} Documentation' .format (about [' __title__' ]),
119
- about [' __author__' ],
120
- about [' __package_name__' ],
121
- about [' __description__' ],
122
- ' Miscellaneous' ,
116
+ " index" ,
117
+ "{}" .format (about [" __package_name__" ]),
118
+ " {} Documentation" .format (about [" __title__" ]),
119
+ about [" __author__" ],
120
+ about [" __package_name__" ],
121
+ about [" __description__" ],
122
+ " Miscellaneous" ,
123
123
)
124
124
]
125
125
126
- intersphinx_mapping = {' http://docs.python.org/' : None }
126
+ intersphinx_mapping = {" http://docs.python.org/" : None }
127
127
128
128
129
129
def linkcode_resolve (domain , info ): # NOQA: C901
@@ -135,18 +135,18 @@ def linkcode_resolve(domain, info): # NOQA: C901
135
135
From https://github.com/numpy/numpy/blob/v1.15.1/doc/source/conf.py, 7c49cfa
136
136
on Jul 31. License BSD-3. https://github.com/numpy/numpy/blob/v1.15.1/LICENSE.txt
137
137
"""
138
- if domain != 'py' :
138
+ if domain != "py" :
139
139
return None
140
140
141
- modname = info [' module' ]
142
- fullname = info [' fullname' ]
141
+ modname = info [" module" ]
142
+ fullname = info [" fullname" ]
143
143
144
144
submod = sys .modules .get (modname )
145
145
if submod is None :
146
146
return None
147
147
148
148
obj = submod
149
- for part in fullname .split ('.' ):
149
+ for part in fullname .split ("." ):
150
150
try :
151
151
obj = getattr (obj , part )
152
152
except Exception :
@@ -180,18 +180,18 @@ def linkcode_resolve(domain, info): # NOQA: C901
180
180
181
181
fn = relpath (fn , start = dirname (libtmux .__file__ ))
182
182
183
- if ' dev' in about [' __version__' ]:
183
+ if " dev" in about [" __version__" ]:
184
184
return "%s/blob/master/%s/%s%s" % (
185
- about [' __github__' ],
186
- about [' __package_name__' ],
185
+ about [" __github__" ],
186
+ about [" __package_name__" ],
187
187
fn ,
188
188
linespec ,
189
189
)
190
190
else :
191
191
return "%s/blob/v%s/%s/%s%s" % (
192
- about [' __github__' ],
193
- about [' __version__' ],
194
- about [' __package_name__' ],
192
+ about [" __github__" ],
193
+ about [" __version__" ],
194
+ about [" __package_name__" ],
195
195
fn ,
196
196
linespec ,
197
197
)
0 commit comments