Allow #//apple_ref/… links to expand docs too #1167
Merged
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.
Currently Jazzy generates
<a name=…>
tags for both USR-style anchors and Dash-styleapple_ref
anchors:The
apple_ref
anchors have several advantages: they are human-readable, generally make for shorter links, and (most importantly) are less prone to changes between doc generation cycles and thus make for more stable long-term links from e.g. other documentation.However, they have a shortcoming in Jazzy: a link of the form
Foo.html#//apple_ref/swift/Method/load()
currently scrolls to the correct item, but does not expand it.This PR also expands the item when thus linked, just as
Foo.html#/s:6Siesta8ResourceC4loadAA7Request_pyF
would.