how to choose the text use in a cross reference with sphinx?
Date : March 29 2020, 07:55 AM
will be helpful for those in need Using sphinx, I included a figure using the following syntax. , You can provide a custom link text for :ref: targets, like this: See figure :ref:`Link text <struct_NiO>` bla bla bla
|
How would I cross-reference a function generated by autodoc in Sphinx?
Date : March 29 2020, 07:55 AM
Any of those help You don't need to add labels. In order to refer to a Python class, method, or other documented object, use the markup provided by the Python domain. For example, the following defines a cross-reference to the mymethod method: :py:meth:`mymodule.MyClass.mymethod`
:meth:`mymodule.MyClass.mymethod`
|
Sphinx cross reference not working
Date : March 29 2020, 07:55 AM
will be helpful for those in need Either you can use the angle brackets with text override in the ref, or leave out them out. In other words, remove the angle brackets unless you are going to add override text.
Error message should be better.
|
Sphinx is not creating cross reference link
Date : March 29 2020, 07:55 AM
This might help you You are using straight single quotes instead of backticks to delimit the role content. For example, :func:'atest' must be changed to :func:`atest`.
References:
|
Sphinx: cross-reference indexed item
Date : January 02 2021, 06:48 AM
|
Boards Message :
Related QUESTIONS :