Skip to content

Commit 0641d7a

Browse files
committed
add docs group to uv dependencies for ci lint check
1 parent 082f3ef commit 0641d7a

4 files changed

Lines changed: 9 additions & 11 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
version: '0.10.2'
3030

3131
- name: Install dependencies
32-
run: uv sync --all-extras
32+
run: uv sync --all-extras --group docs
3333

3434
- name: Run lints
3535
run: ./scripts/lint

docs/conf.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import sys
1010
import pkgutil
1111
from typing import get_type_hints
12+
from typing_extensions import override
1213

1314
from sphinx.errors import PycodeError
1415
from sphinx.pycode import ModuleAnalyzer
@@ -95,6 +96,7 @@ class _InheritedDocsTypedDictDocumenter(TypedDictDocumenter):
9596
Patching sphinx_toolbox 4.1.2.
9697
"""
9798

99+
@override
98100
def sort_members(
99101
self,
100102
documenters: list[tuple[Documenter, bool]],
@@ -120,12 +122,12 @@ def sort_members(
120122
if required_keys:
121123
self.add_line("", sourcename)
122124
self.add_line(":Required Keys:", sourcename)
123-
self.document_keys(required_keys, types, docstrings)
125+
self.document_keys(required_keys, types, docstrings) # pyright: ignore[reportUnknownMemberType]
124126
self.add_line("", sourcename)
125127
if optional_keys:
126128
self.add_line("", sourcename)
127129
self.add_line(":Optional Keys:", sourcename)
128-
self.document_keys(optional_keys, types, docstrings)
130+
self.document_keys(optional_keys, types, docstrings) # pyright: ignore[reportUnknownMemberType]
129131
self.add_line("", sourcename)
130132

131133
return []
@@ -160,7 +162,7 @@ def _inject_type_submodules(_app: Sphinx, docname: str, source: list[str]) -> No
160162

161163
def setup(app: Sphinx) -> None:
162164
app.add_autodocumenter(_InheritedDocsTypedDictDocumenter, override=True)
163-
app.connect("source-read", _inject_type_submodules)
165+
app.connect("source-read", _inject_type_submodules) # pyright: ignore[reportUnknownMemberType]
164166

165167

166168
# Intersphinx mapping

pyproject.toml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ docs = [
7272
"furo>=2025.9.25",
7373
"sphinx>=7.4.7",
7474
"sphinx-autodoc-typehints>=2.3.0",
75+
"sphinx-tabs>=3.4.0",
7576
"sphinx-toolbox>=4.0.0",
7677
]
7778

@@ -138,7 +139,6 @@ exclude = [
138139
"_dev",
139140
".venv",
140141
".git",
141-
"docs",
142142
]
143143

144144
reportImplicitOverride = true
@@ -198,12 +198,6 @@ module = "black.files.*"
198198
ignore_errors = true
199199
ignore_missing_imports = true
200200

201-
# Sphinx packages are only installed in the docs dependency group,
202-
# not in the dev group used by CI linters.
203-
[[tool.mypy.overrides]]
204-
module = ["sphinx.*", "sphinx_toolbox.*"]
205-
ignore_missing_imports = true
206-
207201

208202
[tool.ruff]
209203
line-length = 120

uv.lock

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)