linuxdoc/pyproject.toml at master · return42/linuxdoc · 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# SPDX-License-Identifier: AGPL-3.0-or-later

# ==============================================================================
[build-system]
# ==============================================================================

requires = ["hatchling"]
build-backend = "hatchling.build"

# ==============================================================================
[project]
# ==============================================================================

name = "linuxdoc"
dynamic = ["version"]

description = "Sphinx-doc extensions & tools to extract documentation from C/C++ source file comments."
readme = "README.rst"
requires-python = ">=3.9"
license = "AGPL-3.0-or-later"
keywords = ["sphinx extension", "doc", "source code comments", "kernel-doc", "linux"]
authors = [
  { name = "Markus Heiser", email = "markus.heiser@darmarit.de" },
]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: Developers",
  "Intended Audience :: Other Audience",
  "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
  "Programming Language :: Python",
  "Topic :: Software Development :: Documentation",
  "Topic :: Software Development :: Libraries",
  "Topic :: Text Processing",
  "Topic :: Utilities",
]
dependencies = [
  "fspath",
  "setuptools",
  "docutils",
  "sphinx",
]

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

[project.scripts]
"linuxdoc.rest" = "linuxdoc.rest:main"
"linuxdoc.autodoc" = "linuxdoc.autodoc:main"
"linuxdoc.lintdoc" = "linuxdoc.lint:main"
"linuxdoc.grepdoc" = "linuxdoc.grepdoc:main"


# ==============================================================================
[tool.hatch]
# ==============================================================================

[tool.hatch.version]
path = "linuxdoc/__pkginfo__.py"

# hatch env: default
# ------------------

[tool.hatch.envs.default]
python = "3.13"
dependencies = [
  "argparse-manpage",
  "basedpyright==1.27.*",
  "black==25.1.*",
  "furo",
  "isort==6.0.*",
  "pylint",
  "pylint==3.3.*",
  "sphinx-autobuild",
  "sphinx-issues",
  "sphinx-jinja",
  "sphinx-tabs",
  "sphinxcontrib-programoutput",
  "tox",
  "twine",
]

[tool.hatch.envs.default.scripts]

prj = "./prj {args:--help}"

fix = [
  "isort {args:./linuxdoc ./docs/conf.py ./tests}",
  "black {args:./linuxdoc ./docs/conf.py ./tests}",
]

isort-check = "isort --diff {args:./linuxdoc ./tests}"
black-check = "black --check --diff {args:./linuxdoc ./tests}"
pylint-check = "pylint --output-format=parseable {args:./linuxdoc ./tests}"
basedpyright-check = "basedpyright {args:./linuxdoc ./tests}"

check = [
  "isort-check",
  "black-check",
  "pylint-check",
  "basedpyright-check",
  "packaging",
]

# ==============================================================================
[tool.isort]
# ==============================================================================

profile = "black"
atomic = true
use_parentheses = true
include_trailing_comma = true