docs: enable SPI documentation rendering via DocC - #125
Conversation
There was a problem hiding this comment.
.spi.yml drives the documentation engine:
| ## 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). |
There was a problem hiding this comment.
That link will start to work after the merge (when SPI picks up the changes)
|
Could you add our license header? |
|
@kou I added the header from the README to the documentation index file. Finger crossed Apple's weird build tools work with that! |
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
|
Thanks @kou I didn't think of the yaml file! |
|
@DivineDominion https://swiftpackageindex.com/apache/arrow-swift/ shows the "Documentation" link but https://swiftpackageindex.com/apache/arrow-swift/main/documentation/arrow returns "An unknown error occurred.". How to debug this? |
|
Wow. It shows our documentation now... Why...? |
|
Tagged releases are indexed and documentation is generated 'immediately' but for main branch updates, they run nightly jobs to check only, so it may take a while. @kou Edit: oh, it's back to errors. I'll ask! |
|
I understand. Thanks for the explanation! |
2 participants
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.