microdocs/pyproject.toml at main · bartTC/microdocs · 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
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "microdocs"
version = "1.2.1"
description = "Transform your Markdown files into a self-contained HTML documentation site."
readme = "README.md"
authors = [
    { name = "Martin Mahner", email = "martin@mahner.org" }
]
license = "MIT"
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Environment :: Web Environment",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Documentation",
    "Topic :: Internet :: WWW/HTTP",
    "Topic :: Software Development :: Documentation",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Text Processing :: Markup :: HTML",
    "Topic :: Text Processing :: Markup :: Markdown",
    "Typing :: Typed",
]
requires-python = ">=3.11"
dependencies = [
    "jinja2",
    "markdown",
    "mdx-truly-sane-lists",
    "pymdown-extensions",
    "typer",
]

[project.urls]
Homepage = "https://github.com/bartTC/microdocs/"
Repository = "https://github.com/bartTC/microdocs/"
Documentation = "https://github.com/bartTC/microdocs/blob/main/README.md"
Changelog = "https://github.com/bartTC/microdocs/blob/main/CHANGELOG.md"
"Bug Tracker" = "https://github.com/bartTC/microdocs/issues"

[dependency-groups]
dev = [
    "pre-commit",
    "pytest",
    "pytest-cov",
    "ruff",
]

[project.scripts]
microdocs = "microdocs:main"

[tool.hatch.build.targets.wheel]
packages = ["microdocs"]

[tool.hatch.build]
exclude = [
    "playwright/",
    "templates_src/",
    "node_modules/",
    "*.config.js",
    "package.json",
    "package-lock.json",
    "vite.config.js",
]

[tool.uv]
package = true

[tool.ruff]
target-version = "py311"
lint.select = ["ALL"]
lint.ignore = [
    # Valid exclusions.
    "COM812", # Conflicts with ruff format
    "E501", # Line too long (>88)
    "D203", # incorrect-blank-line-before-class (conflicts with D211)
    "D212", # Don't require summary on first line
    "ERA001", # Found commented-out code
    "FBT", # Flake Boolean Trap (don't use arg=True in functions)
    "FIX", # Line contains TODO/FIXME. Consider resolving.
    "PLR0913", # Too many arguments in function definition

]

[tool.ruff.lint.extend-per-file-ignores]
"test*.py" = [
    "S101", # Use of `assert` detected
    "PLR2004", # Magic value used in comparison, consider replacing <int> with a constant variable
]

[tool.pytest.ini_options]
python_files = ["*.py"]

[tool.coverage]
run.omit = [
    "microdocs/tests/*",
]
report.exclude_lines = [
    "pragma: no cover",
    "if TYPE_CHECKING:",
]

[tool.tailwhip]
skip_expressions = ["{{", "{%", "?"]