You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.
Using multiple return values, sphinx/napoleon doesn't hyperlink the return types. I tried with and without explicitly naming the return values.
Python version: 3.8.10
Sphinx version: 4.0.2
r""" Parameters ---------- n : int A positive integer. B : int, optional The max divisor in the trial division. The default is `None` which corresponds to :math:`B = \sqrt{n}`. If :math:`B > \sqrt{n}`, the algorithm will only search up to :math:`\sqrt{n}`, since a factor of :math:`n` cannot be larger than :math:`\sqrt{n}`. Returns ------- list The discovered prime factors :math:`\{p_1, \dots, p_k\}`. list The corresponding prime exponents :math:`\{e_1, \dots, e_k\}`. int The residual factor :math:`n_r`. """
renders like this
And when naming the return values
r""" Parameters ---------- n : int A positive integer. B : int, optional The max divisor in the trial division. The default is `None` which corresponds to :math:`B = \sqrt{n}`. If :math:`B > \sqrt{n}`, the algorithm will only search up to :math:`\sqrt{n}`, since a factor of :math:`n` cannot be larger than :math:`\sqrt{n}`. Returns ------- p : list The discovered prime factors :math:`\{p_1, \dots, p_k\}`. e : list The corresponding prime exponents :math:`\{e_1, \dots, e_k\}`. n_r : int The residual factor :math:`n_r`. """
it renders like this
However, when using a single return value, the hyperlinks work as expected.
FYI, I am using intershpinx_mapping to link to the python docs, which correctly works for the Parameters section.
Using multiple return values, sphinx/napoleon doesn't hyperlink the return types. I tried with and without explicitly naming the return values.
Python version: 3.8.10
Sphinx version: 4.0.2
renders like this
And when naming the return values
it renders like this
However, when using a single return value, the hyperlinks work as expected.
FYI, I am using
intershpinx_mapping
to link to the python docs, which correctly works for theParameters
section.The text was updated successfully, but these errors were encountered: