sphinx-js/pyproject.toml at master · pyodide/sphinx-js · 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
[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "sphinx-js"
description = "Support for using Sphinx on JSDoc-documented JS code"
readme = "README.md"
license = {text = "MIT"}
authors = [
    {name = "Hood Chatham", email = "roberthoodchatham@gmail.com"},
]
requires-python = ">=3.10"
dependencies = [
    "attrs",
    "cattrs<25.1",
    "Jinja2>2.0",
    "markupsafe",
    "parsimonious>=0.10.0,<0.11.0",
    "Sphinx>=4.1.0",
]
keywords = [
    "docs",
    "documentation",
    "javascript",
    "js",
    "jsdoc",
    "restructured",
    "sphinx",
    "typedoc",
    "typescript",
]
classifiers = [
    "Framework :: Sphinx :: Domain",
    "Framework :: Sphinx :: Extension",
    "Intended Audience :: Developers",
    "Natural Language :: English",
    "Development Status :: 5 - Production/Stable",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Topic :: Documentation :: Sphinx",
    "Topic :: Software Development :: Documentation",
    "Typing :: Typed",
]
dynamic = ["version"]

[project.urls]
Homepage = "https://github.com/pyodide/sphinx-js"

[project.optional-dependencies]
test = [
    "beautifulsoup4",
    "build",
    "defusedxml",
    "nox",
    "pytest-cov",
    "recommonmark",
    "twine",
]

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

[tool.hatch.build.targets.sdist]
include = [
    "/sphinx_js",
    "/tests",
    "/LICENSE",
    "/requirements_dev.txt",
    "/noxfile.py",
    "/README.md",
]

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

[tool.mypy]
python_version = "3.10"
show_error_codes = true
warn_unreachable = true
enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]

# Strict checks
warn_unused_configs = true
check_untyped_defs = true
disallow_any_generics = true
disallow_subclassing_any = true
disallow_untyped_calls = true
disallow_untyped_defs = true
disallow_incomplete_defs = true
disallow_untyped_decorators = true
no_implicit_optional = true
warn_redundant_casts = true
warn_unused_ignores = true
warn_return_any = true
no_implicit_reexport = true
strict_equality = true

[[tool.mypy.overrides]]
module = "sphinx_js.parsers"
disallow_untyped_defs = false
disallow_untyped_calls = false


[tool.ruff]
lint.select = [
  "E",     # pycodestyles
  "W",     # pycodestyles
  "F",     # pyflakes
  "B0",    # bugbear (all B0* checks enabled by default)
  "B904",  # bugbear (Within an except clause, raise exceptions with raise ... from err)
  "B905",  # bugbear (zip() without an explicit strict= parameter set.)
  "UP",    # pyupgrade
  "I",     # isort
  "PGH",   # pygrep-hooks
]
lint.ignore = ["E402", "E501", "E731", "E741", "B904", "B020", "UP031"]
target-version = "py310"