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
|
from __future__ import annotations
extensions = [
'sphinx.ext.autodoc',
'jaraco.packaging.sphinx',
]
master_doc = "index"
html_theme = "furo"
pygments_style = "sphinx"
# Link dates and other references in the changelog
extensions += ['rst.linker']
link_files = {
'../NEWS.rst': dict(
using=dict(GH='https://github.com'),
replace=[
dict(
pattern=r'(Issue #|\B#)(?P<issue>\d+)',
url='{package_url}/issues/{issue}',
),
dict(
pattern=r'(?m:^((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n)',
with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n',
),
dict(
pattern=r'PEP[- ](?P<pep_number>\d+)',
url='https://peps.python.org/pep-{pep_number:0>4}/',
),
],
)
}
# Be strict about any broken references
nitpicky = True
nitpick_ignore: list[tuple[str, str]] = []
nitpick_ignore = [
('py:class', '_io.BufferedRandom'),
('py:class', '_io.BufferedReader'),
('py:class', '_io.BufferedWriter'),
('py:class', '_io.FileIO'),
('py:class', '_io.TextIOWrapper'),
('py:class', 'Literal[-1, 1]'),
('py:class', 'OpenBinaryMode'),
('py:class', 'OpenBinaryModeReading'),
('py:class', 'OpenBinaryModeUpdating'),
('py:class', 'OpenBinaryModeWriting'),
('py:class', 'OpenTextMode'),
('py:class', '_IgnoreFn'),
('py:class', '_CopyFn'),
('py:class', '_Match'),
('py:class', '_OnErrorCallback'),
('py:class', '_OnExcCallback'),
('py:class', 'os.statvfs_result'),
('py:class', 'ModuleType'),
]
# Include Python intersphinx mapping to prevent failures
# jaraco/skeleton#51
extensions += ['sphinx.ext.intersphinx']
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
}
# Preserve authored syntax for defaults
autodoc_preserve_defaults = True
# Add support for linking usernames, PyPI projects, Wikipedia pages
github_url = 'https://github.com/'
extlinks = {
'user': (f'{github_url}%s', '@%s'),
'pypi': ('https://pypi.org/project/%s', '%s'),
'wiki': ('https://wikipedia.org/wiki/%s', '%s'),
}
extensions += ['sphinx.ext.extlinks']
# local
extensions += ['jaraco.tidelift']
|
