ImplicitHyperlinkTargetPass
in package
implements
CompilerPass
FinalYes
Resolves the hyperlink target for each section in the document.
This follows the reStructuredText rules as outlined in: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#implicit-hyperlink-targets
Table of Contents
Interfaces
Methods
- getPriority() : int
- run() : DocumentNode[]
- deduplicateSectionIds() : string[]
- fetchExplicitReferences() : string[]
Methods
getPriority()
public
getPriority() : int
Return values
intrun()
public
run(array $documents, CompilerContextInterface $compilerContext) : DocumentNode[]
Parameters
- $documents : array
- $compilerContext : CompilerContextInterface
Return values
DocumentNode[]deduplicateSectionIds()
private
deduplicateSectionIds(array<string|int, Node> $nodes, string[] $knownIds) : string[]
Parameters
- $nodes : array<string|int, Node>
- $knownIds : string[]
Return values
string[]fetchExplicitReferences()
private
fetchExplicitReferences(Node $node) : string[]
Parameters
- $node : Node