Skip to content

docs: enable SPI documentation rendering via DocC #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kou merged 3 commits into from
Jan 21, 2026
Merged

docs: enable SPI documentation rendering via DocC #125

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cc17f1
docs: enable SPI documentation rendering via DocC index
DivineDominion Jan 19, 2026
fa664b1
chore: add license header to Markdown file
DivineDominion Jan 19, 2026
ef66886
Add license header to .spi.yml
DivineDominion Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .spi.yml
View file
Open in desktop

@DivineDominion DivineDominion Jan 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.spi.yml drives the documentation engine:

https://swiftpackageindex.com/swiftpackageindex/spimanifest/1.11.0/documentation/spimanifest/commonusecases#Host-DocC-documentation-in-the-Swift-Package-Index

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
version: 1
Comment thread
DivineDominion marked this conversation as resolved.
builder:
configs:
- documentation_targets: [Arrow]
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ TODO: We should update this after we register this package to Swift Package Inde

## 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).

@DivineDominion DivineDominion Jan 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That link will start to work after the merge (when SPI picks up the changes)


## Getting involved

Expand Down
49 changes: 49 additions & 0 deletions Sources/Arrow/Arrow.docc/Arrow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# ``Arrow``

Apache Arrow: Columnar format for fast data interchange and in-memory analytics.

## Overview

Arrow provides a universal columnar data format optimized for efficient analytic operations. This Swift implementation enables you to:

- Read and write Arrow IPC file and streaming formats
- Build columnar data structures with typed arrays
- Work with record batches and tables
- Encode and decode Swift types to Arrow format
- Interoperate with other Arrow implementations via the C Data Interface

## Topics

### Reading and Writing Data

- ``ArrowReader``
- ``ArrowWriter``

### Core Data Structures

- ``ArrowTable``
- ``RecordBatch``
- ``ArrowColumn``
- ``ChunkedArray``

### Arrays

- ``ArrowArray``
- ``ArrowArrayBuilder``
- ``ArrowArrayHolder``

### Schema and Types

- ``ArrowSchema``
- ``ArrowField``
- ``ArrowType``

### Encoding and Decoding

- ``ArrowEncoder``
- ``ArrowDecoder``

### C Data Interface

- ``ArrowCExporter``
- ``ArrowCImporter``
Loading