Search code examples
pythonpython-sphinxcross-reference

Sphinx is not creating cross-reference link


Any ideas Why sphinx is not creating cross reference links?

I have tried every possible combination to try to get a link to work, no luck. I have tried with the napoleon_google_docstring on and off.

Other references that are create automatically are working ok.

Screenshot


Solution

  • 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: