sphinx-need-sysml/pyproject.toml at main · cpolzer/sphinx-need-sysml · 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
117
[build-system]
requires = ["flit_core >=3.4,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "sphinx-need-sysml"
version = "0.3.0"
description = "Sphinx extension for SysML v2 need types and diagrams via sphinx-needs and PlantUML"
readme = "README.rst"
license = { file = "LICENSE" }
authors = [{ name = "cpolzer", email = "coders@hai-fai.de" }]
classifiers = [
  "Framework :: Sphinx",
  "Framework :: Sphinx :: Extension",
  "Development Status :: 2 - Pre-Alpha",
  "License :: OSI Approved :: MIT License",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Topic :: Documentation",
]
keywords = ["sphinx", "sysml", "sysml-v2", "plantuml", "sphinx-needs"]
requires-python = ">=3.10"
dependencies = [
  "sphinx<9",
  "sphinx-needs>=1.0",
]

[project.optional-dependencies]
test = [
  "nox>=2025.2.9",
  "pytest>=7.0",
  "pytest-cov",
  "sphinxcontrib-plantuml",
  "sphinx-need-svg>=0.3.1",
  "Pillow",
]
docs = [
  "sphinx-immaterial",
  "sphinxcontrib-plantuml",
  "sphinx-need-svg>=0.3.1",
  "Pillow",
]

[dependency-groups]
dev = [
  "pre-commit~=3.0",
  "nox>=2025.2.9",
  "mypy>=1.16.0",
  "ruff>=0.4.0",
  "commitizen",
  "detect-secrets",
]

[tool.flit.module]
name = "sphinx_need_sysml"

[project.urls]
Homepage = "https://github.com/cpolzer/sphinx-need-sysml"
Repository = "https://github.com/cpolzer/sphinx-need-sysml.git"
Documentation = "https://sphinx-need-sysml.readthedocs.io/"

[tool.ruff.lint]
extend-select = [
  "B",
  "C4",
  "FURB",
  "I",
  "ICN",
  "ISC",
  "N",
  "PERF",
  "PGH",
  "PIE",
  "SLF",
]

[tool.mypy]
packages = ["sphinx_need_sysml"]
strict = true
show_error_codes = true
disallow_any_generics = true
disallow_subclassing_any = true
disallow_untyped_calls = true
disallow_untyped_defs = true

[[tool.mypy.overrides]]
module = [
  "sphinx_needs",
  "sphinx_needs.*",
  "docutils",
  "docutils.*",
  "sphinx_need_svg",
  "sphinx_need_svg.*",
]
ignore_missing_imports = true

[tool.ruff]
target-version = "py310"
exclude = ["*.rst"]

[tool.pytest.ini_options]
testpaths = ["tests"]

[tool.commitizen]
name = "cz_conventional_commits"
version = "0.3.0"
version_files = [
  "pyproject.toml:^version",
  "sphinx_need_sysml/__init__.py:VERSION",
]
tag_format = "v$version"
update_changelog_on_bump = true
changelog_file = "CHANGELOG.md"