Should "autodoc_type_aliases" systematically generate links to the alias?

94 views
Skip to first unread message

Thomas Mansencal

unread,
Feb 5, 2022, 1:38:00 AM2/5/22
to sphinx-users
Hello,

I was wondering if it is expected that the autodoc_type_aliases does not systematically generate links to the alias?


colour.RGB_to_YCbCr(RGB: ArrayLikeK: numpy.ndarray = WEIGHTS_YCBCR['ITU-R BT.709']in_bits: Integer =10in_legal: Boolean = Falsein_int: Boolean = Falseout_bits: Integer = 8out_legal: Boolean = Trueout_int:Boolean = False**kwargs: Any)→ numpy.ndarray

I would like ArrayLike to link to the page where it is defined and imported from, i.e. https://colour.readthedocs.io/en/develop/generated/colour.hints.ArrayLike.html#colour.hints.ArrayLike. Using colour.hints.ArrayLike does not work either.

If I don't define ArrayLike in autodoc_type_aliases, then it get "inelegantly" expanded as expected.

Cheers,

Thomas
Reply all
Reply to author
Forward
0 new messages