bugfix @see tag does not work with static function/member #178
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using JSDocs
@see
tag to reference a static function/member causes Sphinx to crash with the following error messageSince we've added the directive
js:staticfunction
we also have to specify a new object type within the JS Domain that allows Sphinx to resolve the any reference.This example code works now:
It's also possible to reference a static function/member by using the
js:func:
roleUnfortunately, there is no way extend Sphinx to define the correct index text for static functions.
See sphinx.domains.javascript.py code snippet
Unless we generate a JS index, we may not notice any restriction...
What do you think??