The docs are only saying that you don't need the extra rst syntax with
:class: or backticks in the See Also section, like you would
elsewhere.

I suspect the issue in your PR is that the thing you are trying to
reference isn't included in Sphinx, so it can't link to anywhere.

Aaron Meurer

On Mon, Mar 23, 2020 at 4:09 PM Chris Smith <[email protected]> wrote:
>
> The documentation says the following about "See Also" sections:
>
>> The See Also section should only be used to reference other SymPy objects. 
>> Anything that is a link should be embedded as a hyperlink in the text of the 
>> docstring instead; see the References section for details.
>> Do not reference classes with class:Classname, class:`Classname`, or 
>> :class:`Classname`, but rather only by their class name.
>
>
> I can't tell from this what they are actually advocating or discouraging. I 
> see that sometimes we have relative references like
>
> - `.file.func` to refer to `func` in the file `file` of the current folder
> - `func` in the same file as the one in which the See Also is appearing
> - `sympy.module.file.func` to give the full path
>
> I am getting an error in https://github.com/sympy/sympy/pull/18940 when 
> trying to use relative referencing. Any help would be appreciated.
>
> /c
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sympy" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to [email protected].
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sympy/69fbd532-7671-4b78-b0b8-40a1b1a63a6c%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sympy/CAKgW%3D6LP1i_HMO1kgWsoiic-WW-K3BpgMv7CfjOZoijcFwjXDw%40mail.gmail.com.

Reply via email to