Add API synopsis titles and cross references #562
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a title to each `[source]` block that is a synopsis. The title uses `[apidef]` if the title is a unique name for a SYCL identifier, otherwise it uses `[apititle]`. My plan is to add tooling that creates automatic cross references for `[apidef]`.
Add an extension which creates automatic links from `[api]#NAME#` to `[apidef]#NAME#`. The `[api]` role is styled the same as `[code]`, which means that we can replace some instances of `[code]` with `[api]` when that role is used to refer to a SYCL identifier. By using `[api]` the identifier will also be a link to the synopsis that defines the identifier. Also change some instances of `[code]` to `[api]` in the math builtin sections to make use of this new ability.
|
For fun, in ruby, we have the in-famous flip-flop operator; in theory, it makes dealing with scope easier. In practice, it's unreadable. |
TApplencourt
approved these changes
Jun 13, 2024
|
Merging as editorial. |
keryell
pushed a commit
that referenced
this pull request
Sep 10, 2024
Add API synopsis titles and cross references
gmlueck
added a commit
that referenced
this pull request
Nov 7, 2024
Add API synopsis titles and cross references (cherry picked from commit 61fe3e2)
gmlueck
added a commit
that referenced
this pull request
Nov 7, 2024
Add API synopsis titles and cross references (cherry picked from commit 61fe3e2)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add a title to each
[source]block that is a synopsis. The title uses[apidef]if the title is a unique name for a SYCL identifier,otherwise it uses
[apititle].Also add an extension which creates automatic cross references to the
[apidef]synopses. In order to make a cross reference, use theAsciidoc role
[api]. This is styled like[code]but also creates across reference. For example,
[api]#foo#creates a cross reference tothe synopsis whose title is
[apidef]#foo#.Replace some uses of
[code]with[api]in the sections defining themath builtins.