structured-tutorials/pyproject.toml at main · mathiasertl/structured-tutorials · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "structured-tutorials"
description = "Add your description here"
readme = "README.md"
license = "MIT"
license-files = ["LICENSE"]
requires-python = ">=3.10"
dependencies = [
    "colorama>=0.4.6",
    "jinja2>=3.1.6",
    "pydantic>=2.11.4",
    "pyyaml>=6.0.2",
    "sphinx>=8.1.0;python_version>='3.11'",
    "sphinx~=8.1.0;python_version<'3.11'",
    "sphinx-inline-tabs>=2025",
    "termcolor>=3.2.0",
    # Python 3.10 does not have Self
    "typing_extensions>=4.6.0;python_version<'3.11'",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Framework :: Sphinx :: Extension",
    "Programming Language :: Python :: 3",
    "Intended Audience :: Developers",
    "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 :: 3 :: Only",
    "Topic :: Documentation :: Sphinx",
    "Typing :: Typed"
]
dynamic = ["version"]

[project.scripts]
structured-tutorial = "structured_tutorials.cli:main"

[project.urls]
Homepage = "https://structured-tutorials.readthedocs.io/"
Documentation = "https://structured-tutorials.readthedocs.io/"
Source = "https://github.com/mathiasertl/structured-tutorials"
Issues = "https://github.com/mathiasertl/structured-tutorials/issues"
Changelog = "https://structured-tutorials.readthedocs.io/en/latest/changelog.html"

[tool.coverage.run]
source = [
    "structured_tutorials",
]
branch = true

[tool.hatch.version]
source = "vcs"

[tool.doc8]
max-line-length = 110
ignore-path = ["docs/_build/"]
ignore = ["D000"]

[tool.mypy]
strict = true
show_error_codes = true
plugins = ["pydantic.mypy"]

[tool.pytest.ini_options]
collect_imported_tests = false
addopts = [
    "--cov",
    "--cov-report=html",
    "--cov-fail-under=100",
    "--random-order",
]
filterwarnings = [
    "always",
    "error:::structured_tutorials",
    "ignore:::sphinx_inline_tabs",
]

[tool.ruff]
extend-exclude = ["migrations", "stubs"]
line-length = 110

[tool.ruff.lint]
extend-select = [
    "B", # flake8-bugbear
    "D", # pydocstyle
    "E", # pycodestyle
    "F", # pyflakes
    "I", # isort
    "G", # flake8-logging-format
    "PT", # flake8-pytest-style
    "UP", # pyupgrade
    "RUF", # ruff specific checks
]

ignore = [
    "D102", # Missing docstring in public method - includes inherited methods
    "D104", # Missing docstring in public package - includes even empty __init__.py files
    "D105", # Missing docstring in magic method - includes __str__() etc
    "D106", # Missing docstring in public nested class - includes Meta/Media classes
    "D107", # Missing docstring for __init__()
    "D203", # incorrect-blank-line-before-class
    "D213", # multi-line-summary-second-line`
    "D301", # Use `r"""` if any backslashes in a docstring - incompatible with doctests!
    "D401", # First line of docstring should be in imperative mood
]

[tool.ruff.lint.flake8-pytest-style]
parametrize-values-type = "tuple"

[tool.ruff.lint.isort]
combine-as-imports = true

[tool.uv]
conflicts = [
    [
        { group = "Sphinx8.1" },
        { group = "Sphinx8.2" },
        { group = "Sphinx9.0" },
        { group = "Sphinx9.1" },
    ],
    [{ group = "Sphinx9.0" }, { group = "Sphinx9.1" }, { group = "rtd" }]
]

[dependency-groups]
dev = [
    "coverage>=7.8.0",
    "doc8>=2.0.0",
    "mypy>=1.15.0",
    "pytest>=8.3.5",
    "pytest-cov>=6.1.1",
    "pytest-random-order>=1.1.1",
    "pytest-subprocess>=1.5.3",
    "ruff>=0.11.10",
    "sphinxcontrib-spelling>=8.0.1",
    "types-colorama>=0.4.15.20250801",
    "types-docutils>=0.21.0.20250604",
    "types-pyyaml>=6.0.12.20250516",
]
rtd = [
    "sphinx-rtd-theme>=3.0.2",
]

"Sphinx8.1" = ["Sphinx~=8.1.0"]
"Sphinx8.2" = ["Sphinx~=8.2.0;python_version>='3.11'"]
"Sphinx9.0" = ["Sphinx~=9.0.0;python_version>='3.11'"]
"Sphinx9.1" = ["Sphinx~=9.1.0;python_version>='3.12'"]