/
pyproject.toml
132 lines (124 loc) · 3.58 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
126
127
128
129
130
131
132
[build-system]
requires = ["pdm-pep517"]
build-backend = "pdm.pep517.api"
[project]
name = "mkdocstrings"
description = "Automatic documentation from sources, for MkDocs."
authors = [{name = "Timothée Mazzucotelli", email = "pawamoy@pm.me"}]
license = {file = "LICENSE"}
readme = "README.md"
requires-python = ">=3.7"
keywords = ["mkdocs", "mkdocs-plugin", "docstrings", "autodoc", "documentation"]
dynamic = ["version"]
classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: ISC License (ISCL)",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Topic :: Documentation",
"Topic :: Software Development",
"Topic :: Software Development :: Documentation",
"Topic :: Utilities",
"Typing :: Typed",
]
dependencies = [
"Jinja2>=2.11.1",
"Markdown>=3.3",
"MarkupSafe>=1.1",
"mkdocs>=1.2",
"mkdocs-autorefs>=0.3.1",
"mkdocstrings-python-legacy>=0.2",
"pymdown-extensions>=6.3",
]
[project.optional-dependencies]
crystal = ["mkdocstrings-crystal>=0.3.4"]
python-legacy = ["mkdocstrings-python-legacy>=0.2.1"]
python = ["mkdocstrings-python>=0.5.2"]
[project.urls]
Homepage = "https://mkdocstrings.github.io"
Documentation = "https://mkdocstrings.github.io"
Changelog = "https://mkdocstrings.github.io/changelog"
Repository = "https://github.com/mkdocstrings/mkdocstrings"
Issues = "https://github.com/mkdocstrings/mkdocstrings/issues"
Discussions = "https://github.com/mkdocstrings/mkdocstrings/discussions"
Gitter = "https://gitter.im/mkdocstrings/community"
Funding = "https://github.com/sponsors/mkdocstrings"
[project.entry-points."mkdocs.plugins"]
mkdocstrings = "mkdocstrings.plugin:MkdocstringsPlugin"
[tool.pdm]
package-dir = "src"
includes = ["src/mkdocstrings"]
version = {use_scm = true}
[tool.pdm.dev-dependencies]
duty = ["duty>=0.7"]
docs = [
"mkdocs-coverage>=0.2",
"mkdocs-gen-files>=0.3",
"mkdocs-literate-nav>=0.4",
"mkdocs-material>=7.3",
"mkdocs-section-index>=0.3",
"mkdocstrings-python>=0.5.1",
"toml>=0.10",
]
format = [
"autoflake>=1.4",
"black>=21.10b0",
"isort>=5.10",
]
maintain = [
# TODO: remove this section when git-changelog is more powerful
"git-changelog>=0.4",
]
quality = [
"darglint>=1.8",
"flake8-bandit>=2.1",
"flake8-black>=0.2",
"flake8-bugbear>=21.9",
"flake8-builtins>=1.5",
"flake8-comprehensions>=3.7",
"flake8-docstrings>=1.6",
"flake8-pytest-style>=1.5",
"flake8-string-format>=0.3",
"flake8-tidy-imports>=4.5",
"flake8-variables-names>=0.0",
"pep8-naming>=0.12",
"wps-light>=0.15",
]
tests = [
"docutils",
# TODO: uncomment once the legacy handler is optional
# "mkdocstrings-python-legacy>=0.1",
"pygments>=2.10", # python 3.6
"pytest>=6.2",
"pytest-cov>=3.0",
"pytest-randomly>=3.10",
"pytest-xdist>=2.4",
"sphinx",
]
typing = [
"mypy>=0.910",
"types-docutils",
"types-markdown>=3.3",
"types-pyyaml",
"types-toml>=0.10",
]
security = ["safety>=1.10"]
[tool.black]
line-length = 120
exclude = "tests/fixtures"
[tool.isort]
line_length = 120
not_skip = "__init__.py"
multi_line_output = 3
force_single_line = false
balanced_wrapping = true
default_section = "THIRDPARTY"
known_first_party = "mkdocstrings"
include_trailing_comma = true