mkapi/pyproject.toml at main · daizutabi/mkapi · GitHub

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
[build-system]
requires = ["uv_build"]
build-backend = "uv_build"

[project]
name = "mkapi"
version = "4.5.0"
description = "MkDocs plugin for automatic API documentation generation from Python docstrings"
readme = "README.md"
license = { file = "LICENSE" }
authors = [{ name = "daizutabi", email = "daizutabi@gmail.com" }]
keywords = ["mkdocs", "documentation", "api", "docstring", "markdown"]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Framework :: MkDocs",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: MIT License",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Programming Language :: Python",
  "Topic :: Documentation",
  "Topic :: Software Development :: Documentation",
  "Topic :: Software Development :: Libraries :: Python Modules",
  "Topic :: Text Processing :: Markup :: Markdown",
  "Typing :: Typed",
]
requires-python = ">=3.10"
dependencies = [
  "astdoc>=1.3.0",
  "jinja2",
  "mkdocs-material",
  "mkdocs>=1.6.0",
  "tomli>=1.1.0; python_version<'3.11'",
]

[project.urls]
Documentation = "https://daizutabi.github.io/mkapi/"
Source = "https://github.com/daizutabi/mkapi"
Issues = "https://github.com/daizutabi/mkapi/issues"

[project.entry-points."mkdocs.plugins"]
mkapi = "mkapi.plugin:Plugin"

[dependency-groups]
dev = [
  "pytest>=9.0.1",
  "pytest-clarity>=1",
  "pytest-cov>=7",
  "pytest-randomly>=4",
  "pytest-xdist>=3.8",
]

[tool.pytest.ini_options]
addopts = ["--doctest-modules", "--cov=mkapi", "--cov-report=lcov:lcov.info"]

[tool.coverage.report]
exclude_lines = ["if TYPE_CHECKING:", "raise NotImplementedError"]
skip_covered = true

[tool.ruff]
line-length = 88
target-version = "py310"
exclude = ["tests/examples/*.py", "example/*.py"]

[tool.ruff.lint]
select = ["ALL"]
unfixable = ["F401"]
ignore = [
  "A005",
  "ANN002",
  "ANN003",
  "ARG001",
  "ARG002",
  "C901",
  "D105",
  "D203",
  "D213",
  "FBT001",
  "FBT002",
  "PERF401",
  "PGH003",
  "PLC0415",
  "PLR0912",
  "PLR2004",
  "SIM102",
]

[tool.ruff.lint.per-file-ignores]
"config.py" = ["D401"]
"src/mkapi/plugin.py" = ["D"]
"tests/*" = ["ANN", "ARG", "D", "FBT", "PLR", "RUF", "S"]

[tool.pyright]
include = ["src", "tests"]
reportIncompatibleMethodOverride = false
strictDictionaryInference = true
strictListInference = true
strictSetInference = true