OptionalLinkTargetsNode
extends
LinkTargetNode
in
Makes the implementing node an optional link target. If Noindex is true no references are generated, there is no entry in the objects index and no warning about duplicate ids.
Used for example in https://sphinx-toolbox.readthedocs.io/en/stable/extensions/confval.html#directive-option-confval-noindex
Table of Contents
Methods
- getId() : string
- getLinkText() : string
- getLinkType() : string
- isNoindex() : bool
Methods
getId()
public
getId() : string
Return values
stringgetLinkText()
public
getLinkText() : string
Return values
stringgetLinkType()
public
getLinkType() : string
Return values
stringisNoindex()
public
isNoindex() : bool