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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
[build-system]
build-backend = 'setuptools.build_meta'
requires = ['setuptools>=61.2']
[project]
name = 'numpydoc'
description = 'Sphinx extension to support docstrings in Numpy format'
readme = 'README.rst'
requires-python = '>=3.9'
dynamic = ['version']
keywords = [
'sphinx',
'numpy',
]
classifiers = [
'Development Status :: 5 - Production/Stable',
'Environment :: Plugins',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Programming Language :: Python :: 3.12',
'Topic :: Documentation',
]
dependencies = [
'sphinx>=6',
'tabulate>=0.8.10',
"tomli>=1.1.0;python_version<'3.11'",
]
[[project.authors]]
name = 'Pauli Virtanen and others'
email = 'pav@iki.fi'
[project.license]
file = 'LICENSE.txt'
[project.urls]
Homepage = 'https://numpydoc.readthedocs.io'
Source = 'https://github.com/numpy/numpydoc/'
[project.optional-dependencies]
developer = [
'pre-commit>=3.3',
"tomli; python_version < '3.11'",
]
doc = [
'numpy>=1.22',
'matplotlib>=3.5',
'pydata-sphinx-theme>=0.13.3',
'sphinx>=7',
'intersphinx_registry',
]
test = [
'pytest',
'pytest-cov',
'matplotlib',
]
[project.scripts]
numpydoc = 'numpydoc.cli:main'
[tool.changelist]
title_template = "{version}"
# Profiles that are excluded from the contributor list.
ignored_user_logins = ["dependabot[bot]", "pre-commit-ci[bot]", "web-flow"]
[tool.ruff.lint]
extend-select = [
"B", # flake8-bugbear
"I", # isort
"ARG", # flake8-unused-arguments
"C4", # flake8-comprehensions
"EM", # flake8-errmsg
"ICN", # flake8-import-conventions
"G", # flake8-logging-format
"PGH", # pygrep-hooks
"PIE", # flake8-pie
"PL", # pylint
"PT", # flake8-pytest-style
"PTH", # flake8-use-pathlib
"RET", # flake8-return
"RUF", # Ruff-specific
"SIM", # flake8-simplify
"T20", # flake8-print
"UP", # pyupgrade
"YTT", # flake8-2020
"EXE", # flake8-executable
"NPY", # NumPy specific rules
"PD", # pandas-vet
"FURB", # refurb
"PYI", # flake8-pyi
]
ignore = [
"PLR09", # Too many <...>
"PLR2004", # Magic value used in comparison
"ISC001", # Conflicts with formatter
"ARG001", # FIXME: consider removing this and the following rules from this list
"ARG002",
"B004",
"B007",
"B023",
"B028",
"B034",
"C408",
"E402",
"E741",
"EM101",
"EM102",
"EXE001",
"F401",
"F811",
"F821",
"F841",
"PIE810",
"PLW0603",
"PLW2901",
"PLW3301",
"PT006",
"PT007",
"PT011",
"PT012",
"PT013",
"PTH100",
"PTH118",
"PTH120",
"PTH123",
"PYI024",
"RET503",
"RET504",
"RET505",
"RET506",
"RET507",
"RET508",
"RUF005",
"RUF012",
"RUF013",
"SIM102",
"SIM105",
"SIM108",
"SIM115",
"T201",
"UP006",
"UP031",
"UP035",
]
[tool.ruff.lint.per-file-ignores]
"doc/example.py" = ["ARG001", "F401", "I001"]
[tool.ruff.format]
docstring-code-format = true
[tool.setuptools]
include-package-data = false
packages = [
'numpydoc',
'numpydoc.hooks',
]
[tool.setuptools.dynamic.version]
attr = 'numpydoc.__version__'
[tool.setuptools.package-data]
numpydoc = [
'tests/test_*.py',
'tests/tinybuild/Makefile',
'tests/tinybuild/index.rst',
'tests/tinybuild/*.py',
'templates/*.rst',
]
[tool.pytest.ini_options]
addopts = '''
--showlocals --doctest-modules --cov-report= --cov=numpydoc
--junit-xml=junit-results.xml --ignore=doc/ --ignore=tools/'''
junit_family = 'xunit2'
|
