sphinx-autodoc-typehints

sphinx-autodoc-typehints copied to clipboard

Can't use `_typeshed` in TYPE_CHECKING block

3

Example: ```python if TYPE_CHECKING: from _typeshed import StrPath def foo(path: StrPath) -> StrPath: return path ``` Output (fails a build on read the docs): ```none WARNING: Failed guarded type import...

nineteendo

updates: - [github.com/python-jsonschema/check-jsonschema: 0.33.0 → 0.33.1](https://github.com/python-jsonschema/check-jsonschema/compare/0.33.0...0.33.1) - [github.com/astral-sh/ruff-pre-commit: v0.11.13 → v0.12.0](https://github.com/astral-sh/ruff-pre-commit/compare/v0.11.13...v0.12.0) - [github.com/rbubley/mirrors-prettier: v3.5.3 → v3.6.0](https://github.com/rbubley/mirrors-prettier/compare/v3.5.3...v3.6.0)

pre-commit-ci[bot]

Hi, I tried this project for my doc, but realized that it seemed to ignore the `__signature__` of objects. Am I right? This is critical as in my case I...

ego-thales

Annotations should perhaps not be rendered in the docs using `:py:class:`

10

Consider the apidocs, using sphinx-autodoc-typehints, of ``` def f1(x): """ A function. :param int x: The x. """ def f2(x: int): """ A function. :param x: The x. """ ```...

anntzer

### Describe the bug I encountered a very strange bug, where the build just stops, that is triggered by commenting in- and out a function that does not even have...

mcocdawc

#297 did the opposite of what the author of any moderately complex overloaded signature wants: it removed it from the docs. We should make sure all overloaded signatures appear in...

flying-sheep

`sphinx-autodoc-typehints` generates an error and a warning when processing this function: ``` def foo() -> int: """ Description. .. container:: More description. """ return ``` ``` /path/to/file:5: ERROR: Content block...

trevorbaca

``sphinx-autodoc-typehints`` will cause a docstring to be processed twice: once by its own ``_parser`` module, and once by sphinx.ext.autodoc. This is a problem when directives that have (non-idempotent) side-effects are...

marten-de-vries

Using Type Aliases

11

I have a type alias defined using NewType: ```python OutcomeUtilityMapping = NewType( "OutcomeUtilityMapping", Union[ Callable[[Union["Outcome", int, str, float]], "UtilityValue"], Mapping[Union[Sequence, Mapping, int, str, float], "UtilityValue"], ], ) ``` Now one...

yasserfarouk