-
Notifications
You must be signed in to change notification settings - Fork 8
/
pyproject.toml
125 lines (118 loc) · 3.42 KB
/
pyproject.toml
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
[build-system]
build-backend = "hatchling.build"
requires = [
"hatch-vcs>=0.4",
"hatchling>=1.24",
]
[project]
name = "sphinx-argparse-cli"
description = "render CLI arguments (sub-commands friendly) defined by argparse module"
readme = "README.md"
keywords = [
"argparse",
"sphinx",
]
license = "MIT"
maintainers = [
{ name = "Bernat Gabor", email = "gaborjbernat@gmail.com" },
] # noqa: E999
requires-python = ">=3.9"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Framework :: Sphinx",
"Framework :: Sphinx :: Extension",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: Implementation :: CPython",
"Topic :: Documentation",
"Topic :: Documentation :: Sphinx",
]
dynamic = [
"version",
]
dependencies = [
"sphinx>=7.3.5",
]
optional-dependencies.test = [
"covdefaults>=2.3",
"defusedxml>=0.7.1", # needed for sphinx.testing
"pytest>=8.1.1",
"pytest-cov>=5",
]
urls.Documentation = "https://github.com/tox-dev/sphinx-argparse-cli#sphinx-argparse-cli"
urls.Homepage = "https://github.com/tox-dev/sphinx-argparse-cli"
urls.Source = "https://github.com/tox-dev/sphinx-argparse-cli"
urls.Tracker = "https://github.com/tox-dev/sphinx-argparse-cli/issues"
[tool.hatch]
build.hooks.vcs.version-file = "src/sphinx_argparse_cli/version.py"
build.targets.sdist.include = [
"/src",
"/tests",
]
version.source = "vcs"
[tool.black]
line-length = 120
[tool.ruff]
target-version = "py38"
line-length = 120
lint.select = [
"ALL",
]
lint.per-file-ignores."roots/**/*.py" = [
"D", # no docs
"INP001", # no namespace
]
lint.per-file-ignores."tests/**/*.py" = [
"D", # don"t care about documentation in tests
"FBT", # don"t care about booleans as positional arguments in tests
"INP001", # no implicit namespace
"PLC2701", # private import
"PLR0913", # any number of arguments in tests
"PLR0917", # any number of arguments in tests
"PLR2004", # Magic value used in comparison, consider replacing with a constant variable
"S101", # asserts allowed in tests...
"S603", # `subprocess` call: check for execution of untrusted input
]
lint.isort = { known-first-party = [
"sphinx_argparse_cli",
], required-imports = [
"from __future__ import annotations",
] }
lint.ignore = [
"ANN101", # no type annotation for self
"ANN401", # allow Any as type annotation
"COM812", # Conflict with formatter
"CPY", # No copyright statements
"D203", # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
"D212", # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible
"ISC001", # Conflict with formatter
"S104", # Possible binding to all interface
]
[tool.codespell]
builtin = "clear,usage,en-GB_to_en-US"
count = true
[tool.coverage]
html.show_contexts = true
html.skip_covered = false
paths.source = [
"src",
"**/site-packages",
]
report.fail_under = 76
run.dynamic_context = "test_function"
run.parallel = true
run.plugins = [
"covdefaults",
]
run.relative_files = true
[tool.mypy]
python_version = "3.11"
show_error_codes = true
strict = true