Skip to content

Commit 015c8e1

Browse files
DivineDominionkou
andauthored
docs: enable SPI documentation rendering via DocC (#125)
## 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: <img width="3608" height="2298" alt="2026-01-19 07-38-08 Xcode - Arrow Documentation@2x" src="https://github.com/user-attachments/assets/3c53a5df-67f1-4597-bad6-42c138af2a29" /> Enhancements would include more tutorialized content on how to use this, but the project website exists for this for now. Closes #128. --------- Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
1 parent f02fced commit 015c8e1

File tree

3 files changed

+90
-1
lines changed

3 files changed

+90
-1
lines changed

.spi.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
version: 1
19+
builder:
20+
configs:
21+
- documentation_targets: [Arrow]

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Then add `Arrow` to your target's dependencies:
5050

5151
## Getting Started
5252

53-
TODO: We should refer auto generated documentation on Swift Package Index after we register this package to Swift Package Index.
53+
For API documentation and usage examples, see the [documentation on Swift Package Index](https://swiftpackageindex.com/apache/arrow-swift/documentation).
5454

5555
## Getting involved
5656

Sources/Arrow/Arrow.docc/Arrow.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# ``Arrow``
21+
22+
Apache Arrow: Columnar format for fast data interchange and in-memory analytics.
23+
24+
## Overview
25+
26+
Arrow provides a universal columnar data format optimized for efficient analytic operations. This Swift implementation enables you to:
27+
28+
- Read and write Arrow IPC file and streaming formats
29+
- Build columnar data structures with typed arrays
30+
- Work with record batches and tables
31+
- Encode and decode Swift types to Arrow format
32+
- Interoperate with other Arrow implementations via the C Data Interface
33+
34+
## Topics
35+
36+
### Reading and Writing Data
37+
38+
- ``ArrowReader``
39+
- ``ArrowWriter``
40+
41+
### Core Data Structures
42+
43+
- ``ArrowTable``
44+
- ``RecordBatch``
45+
- ``ArrowColumn``
46+
- ``ChunkedArray``
47+
48+
### Arrays
49+
50+
- ``ArrowArray``
51+
- ``ArrowArrayBuilder``
52+
- ``ArrowArrayHolder``
53+
54+
### Schema and Types
55+
56+
- ``ArrowSchema``
57+
- ``ArrowField``
58+
- ``ArrowType``
59+
60+
### Encoding and Decoding
61+
62+
- ``ArrowEncoder``
63+
- ``ArrowDecoder``
64+
65+
### C Data Interface
66+
67+
- ``ArrowCExporter``
68+
- ``ArrowCImporter``

0 commit comments

Comments
 (0)