Generate the SwiftSyntax docc index using CodeGeneration #1394
+541
−56
Conversation
This file contains hidden or 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
|
@swift-ci Please test |
|
@swift-ci Please test |
CodaFi
approved these changes
Mar 9, 2023
kimdv
approved these changes
Mar 9, 2023
| } | ||
| GeneratedFileSpec([swiftSyntaxDir, "generated", "syntaxNodes", baseKind.value], syntaxNode(emitKind: baseKind.key)) | ||
| } + [ | ||
| GeneratedFileSpec([swiftSyntaxDir, "Documentation.docc", "generated", "SwiftSyntax.md"], swiftSyntaxDoccIndex) |
There was a problem hiding this comment.
Nit pick and don't need to be part of this PR, personally I would have a private let generatedPath: String = "generated" next to swiftSyntaxDir, swiftSyntaxBuilderDir and to so on.
There was a problem hiding this comment.
Good suggestion. I updated it.
|
And does DocC not support this kind of thing out of the box? |
It turns out we need this index because docc generates the left sidebar that contains from it.
I’m not sure but in either case it’s good if we can sort the types into groups ourselves rather than listing them all together, which is, what I suspect docc would do by default. |
|
@swift-ci Please test |
|
@swift-ci please test macOS |
|
@swift-ci Please test macOS |
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.
It turns out we need this index because docc generates the left sidebar that contains from it.