docs: enable SPI documentation rendering via DocC #125
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
DivineDominion
commented
Jan 19, 2026
Contributor
Author
There was a problem hiding this comment.
.spi.yml drives the documentation engine:
DivineDominion
commented
Jan 19, 2026
| ## Getting Started | ||
|
|
||
| TODO: We should refer auto generated documentation on Swift Package Index after we register this package to Swift Package Index. | ||
| For API documentation and usage examples, see the [documentation on Swift Package Index](https://swiftpackageindex.com/apache/arrow-swift/documentation). |
Contributor
Author
There was a problem hiding this comment.
That link will start to work after the merge (when SPI picks up the changes)
Member
|
Could you add our license header? |
Contributor
Author
|
@kou I added the header from the README to the documentation index file. Finger crossed Apple's weird build tools work with that! |
kou
reviewed
Jan 19, 2026
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Contributor
Author
|
Thanks @kou I didn't think of the yaml file! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What's Changed
Swift Package Index automatically hosts rendered and browse-able documentation when DocC is used.
This PR adds an overview of the API surface of this library (a Markdown index file) that guides the documentation generator. It can be browsed in Xcode, too, if you want a preview:
Enhancements would include more tutorialized content on how to use this, but the project website exists for this for now.
Closes #128.