Skip Navigation
Type MethodMethod

shouldProcess(relativePath:)

Returns whether a generated HTML file needs doc link post-processing.

static func shouldProcess(relativePath: String) -> Bool

Parameters

relativePath

The path of the file relative to the output root, using / as the separator.

Return Value

true if the file should be processed.

Discussion

Only rendered pages can contain unresolved doc:// links. The shared sidebar document is generated from the navigation index, whose links are already resolved relative to the output root, so it is skipped.