sphinx-autodoc-typehints

sphinx-autodoc-typehints copied to clipboard

sphinx-autodoc-typehints & numpydoc

2

In https://github.com/numpy/numpydoc/issues/196 it was discussed how numpydoc could better handle type annotations. As `sphinx-autodoc-typehints` already provides a way to pull the type annotations from the signature to the docs it...

jrast

updates: - [github.com/astral-sh/ruff-pre-commit: v0.4.2 → v0.4.3](https://github.com/astral-sh/ruff-pre-commit/compare/v0.4.2...v0.4.3)

pre-commit-ci[bot]

2.1.0: filtering all code over `pyupgrade --py38-plus` causes some issues

3

I'v been trying to cut off EOSed already python

kloczek

2.1.0: pytest fails in `tests/test_sphinx_autodoc_typehints.py::test_always_document_param_types[doc_param_type]` unit and pytest warnings

1

I'm packaging your module as an rpm package so I'm using the typical PEP517 based build, install and test cycle used on building packages from non-root account. - `python3 -sBm...

kloczek

updates: - [github.com/tox-dev/pyproject-fmt: 2.0.3 → 2.1.1](https://github.com/tox-dev/pyproject-fmt/compare/2.0.3...2.1.1)

pre-commit-ci[bot]

I've encountered this exception using the current `docutils-0.20.1` ``` [AutoAPI] Adding AutoAPI TOCTree [autoapi/index] to index.rst /tmp/tmpiodbjbom/d819d1f3d0bed977cdfa926fb309a76a8e394462/docs/autoapi/topostats/tracing/dnatracing/index.rst:368: WARNING: Block quote ends without a blank line; unexpected unindent. /tmp/tmpiodbjbom/d819d1f3d0bed977cdfa926fb309a76a8e394462/docs/autoapi/topostats/tracing/skeletonize/index.rst:60: WARNING: Inline...

ns-rse

Sphinx raises warning about custom typehints_formatter

1

Since Sphinx v7.3.0, there is a warning about config values that are not pickleable. When building with `warning_is_error = True`, this fails the build. See https://github.com/sphinx-doc/sphinx/issues/12300 for context. For sphinx-autodoc-typehints,...

jl-wynen

nptyping dependency is troubled

1

nptyping hasn't been updated for numpy 2, which makes the self tests fail with: ``` tests/test_sphinx_autodoc_typehints.py:54: in import nptyping /usr/pkg/lib/python3.12/site-packages/nptyping/__init__.py:32: in from nptyping.ndarray import NDArray /usr/pkg/lib/python3.12/site-packages/nptyping/ndarray.py:40: in from nptyping.shape import...

0-wiz-0

No return type should be added to the documentation of this function: ```python def foo() -> None: """Foo.""" ``` Note that ruff mandates a return type: https://docs.astral.sh/ruff/rules/missing-return-type-undocumented-public-function

nineteendo

Missing links for a union with an unevaluated type alias

1

It's not a big deal, but I would like the links to the type definitions to be present on all pages: https://jsonyx.readthedocs.io/en/latest/api/jsonyx.apply_patch.html ```python # conf.py autodoc_type_aliases = {"_Operation": "_Operation"} ```...

nineteendo