docutools/pyproject.toml at master · axiros/docutools · 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
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "docutools"
version = "2025.11.08"
description = "Documentation Tools for the Mkdocs Material Framework"
authors = [{ name = "Gunther Klessinger", email = "gkle_ss_ing_er@gmx.de" }]
license = "BSD-2-Clause"
readme = "README.md"
requires-python = ">=3.9"
keywords = []
classifiers = [
  "Development Status :: 4 - Beta",
  "License :: OSI Approved :: BSD License",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
]

dependencies = [
  "pycond>=2.0.0",
  "anybadge>=1.7.0",
  "git-changelog",
  "httpx>=0.17.1",
  "markdown-include>=0.8.1",
  "markupsafe==2.0.1",
  "mkdocs>=1.1.2",
  "mkdocs-material>=8.0.0",
  "mkdocs-macros-plugin>=0.5.12",
  "mkdocs-exclude>=1.0.2",
  "mkdocs-pymdownx-material-extras>=1.1.3",
  "pytest>=6.0.1",
  "pytest-cov>=2.10.1",
  "pytest-randomly>=3.4.1",
  "pytest-sugar>=0.9.4",
  "pytest-xdist>=2.1.0",
  "toml>=0.10.1",
  "diagrams",
  "imagesize>=1.0.0",
  "inflection>=0.5.1",
  "coverage>=6.0.2",
]

[project.optional-dependencies]
dev = ["ruff>=0.1.0", "numpy>=1.0.0", "matplotlib>=3.0.0", "mypy>=0.900"]

[project.urls]
Repository = "https://github.com/axiros/docutools"
Homepage = "https://axiros.github.io/docutools/"

# [project.entry-points."mkdocs.plugins"]
# Since uv doesn't support plugin entry points in the same way,
# we'll use the setuptools-compatible format for now
[project.scripts]
mdrun = "lcdoc.lprunner:main"

# Plugin entry points for mkdocs - handled differently in modern packaging
[project.entry-points."mkdocs.plugins"]
"lcd-find-pages" = "lcdoc.mkdocs.find_pages:MDFindPagesPlugin"
"lcd-custom-dir" = "lcdoc.mkdocs.custom_dir:CustomDirPlugin"
"lcd-blacklist" = "lcdoc.mkdocs.blacklist:BlacklistPlugin"
"lcd-lp" = "lcdoc.mkdocs.lp:LPPlugin"
"lcd-md-replace" = "lcdoc.mkdocs.replace:MDReplacePlugin"
"lcd-page-tree" = "lcdoc.mkdocs.page_tree:PageTreePlugin"
"lcd-stats" = "lcdoc.mkdocs.stats:StatsPlugin"

# Tool configurations
[tool.ruff]
# https://docs.astral.sh/ruff/rules/
line-length = 90

[tool.ruff.lint]
extend-select = ["Q"]
select = ["E", "F", "B"] # Enable flake8-bugbear (`B`) rules.
ignore = [
  "E501", # Never enforce `E501` (line length violations).
  "E741", # short var names
  "E731", # lambda
  "B006", # mutables in signature
]
fixable = ["ALL"]
unfixable = [
  "B",    # Avoid trying to fix flake8-bugbear (`B`) violations.
  "F401", # Unused Import
  "F841", # variable assigned but not used
]

[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"
inline-quotes = "single"

[tool.ruff.format]
quote-style = "single"

[tool.mypy]
python_version = "3.9"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true

[tool.pytest.ini_options]
testpaths = ["tests"]
python_files = ["test_*.py", "*_test.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
addopts = "-v --tb=short"

[tool.coverage.run]
source = ["src"]
branch = true

[tool.coverage.report]
precision = 2
show_missing = true
skip_covered = false

[tool.coverage.html]
directory = "build/coverage/overall"

# Hatch configuration for package discovery
[tool.hatch.build.targets.wheel]
packages = ["src/lcdoc"]

[tool.hatch.build.targets.sdist]
include = ["src/lcdoc", "README.md", "LICENSE"]

[dependency-groups]
dev = ["matplotlib>=3.0.0", "mypy>=1.14.1"]