Skip to content

Introduce manual mypy checking on the docs/ dir #1412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sirosen merged 1 commit into from
Aug 5, 2026
Merged

Introduce manual mypy checking on the docs/ dir #1412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,12 @@ sqlite_cache = true
warn_unreachable = true
warn_no_return = true

[[tool.mypy.overrides]]
module = "docs.*"
allow_untyped_calls = true
allow_untyped_defs = true
ignore_missing_imports = true

[tool.pylint]
load-plugins = ["pylint.extensions.docparams"]
accept-no-param-doc = "false"
Expand Down
6 changes: 6 additions & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ commands = mypy src/ {posargs}
base = mypy
commands = mypy --show-error-codes --warn-unused-ignores tests/non-pytest/mypy-ignore-tests/

[testenv:mypy-docs]
base = mypy
# docs isn't really a package, so avoid errors related to it being improperly
# treated like one (this doesn't work via config)
commands = mypy --explicit-package-bases {posargs:docs/}

[testenv:test-lazy-imports]
deps = -r requirements/py{py_dot_ver}/test.txt
commands =
Expand Down
Loading