With the @see tag it is only possible to reference internal documented objects like functions, classes, etc.
Sphinx raises a warning if the referenced target could not be found and it just displays the non-clickable link.
To reference external resources we use the @see {@link} tag a lot from within our JavaScript code. So this pull request
adds the functionality to support JSDocs @see {@link} syntax.
Here's an example:
The pull request covers the synonyms @linkcode and @linkplain though switching to a monospace font is not supported. JSDoc also provides different formats for the @link tag (see https://jsdoc.app/tags-inline-link.html). For now, I just covered the format @see {@link URL}.
Notable changes are
change docs
implement function _prepare_see_alsos() in JSRenderer base class
With the
@see
tag it is only possible to reference internal documented objects like functions, classes, etc. Sphinx raises a warning if the referenced target could not be found and it just displays the non-clickable link.To reference external resources we use the
@see {@link}
tag a lot from within our JavaScript code. So this pull request adds the functionality to support JSDocs@see {@link}
syntax. Here's an example:The pull request covers the synonyms
@linkcode
and@linkplain
though switching to a monospace font is not supported. JSDoc also provides different formats for the@link
tag (see https://jsdoc.app/tags-inline-link.html). For now, I just covered the format@see {@link URL}
.Notable changes are