Sphinx autodoc doesn't recognize a TypedDict key with the name "values"

Viewed 88

Say that I have the following code:

import numpy as np
from typing import TypedDict

class Signal(TypedDict):
    """My signal."""

    name: str  #: Signal name.
    values: np.ndarray  #: Signal values.
    signal_unit: str  #: Signal unit.
    sampling_period: float  #: Signal sampling period.
    time_unit: str  #: Signal sampling period.

When I run sphinx-apidoc -f -n -o ./source ../src/mypackage/ and then run html the code is correctly rendered but for the np.ndarray type. Any idea on how I can fix this?

Let me know if you need more info.

enter image description here

0 Answers
Related