Skip to content

Commit a3576e6

Browse files
authored
Add docc support and publish documentation to GitHub pages (#137)
* Move Guides into docc base location * Add Github gh-page support * Conditionally add docc-plugin dependency * Temp skip AsyncSequenceValidation target
1 parent 94a7ece commit a3576e6

25 files changed

+136
-1
lines changed

Package.swift

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,18 @@ let package = Package(
4141
]),
4242
]
4343
)
44+
45+
#if canImport(Darwin)
46+
import Darwin
47+
let buildingDocs = getenv("BUILDING_FOR_DOCUMENTATION_GENERATION") != nil
48+
#elseif canImport(Glibc)
49+
import Glibc
50+
let buildingDocs = getenv("BUILDING_FOR_DOCUMENTATION_GENERATION") != nil
51+
#else
52+
let buildingDocs = false
53+
#endif
54+
55+
// Only require the docc plugin when building documentation
56+
package.dependencies += buildingDocs ? [
57+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
58+
] : []
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ``AsyncAlgorithms``
2+
3+
**Swift Async Algorithms** is an open-source package of asynchronous sequence and advanced algorithms that involve concurrency, along with their related types.
4+
5+
## Overview
6+
7+
This package has three main goals:
8+
9+
- First-class integration with `async/await`
10+
- Provide a home for time-based algorithms
11+
- Be cross-platform and open source
12+
13+
## Topics
14+
15+
### Getting Started
16+
17+
- <doc:AdjacentPairs>
18+
- <doc:BufferedBytes>
19+
- <doc:Chain>
20+
- <doc:Channel>
21+
- <doc:Chunked>
22+
- <doc:Collections>
23+
- <doc:CombineLatest>
24+
- <doc:Compacted>
25+
- <doc:Debounce>
26+
- <doc:Effects>
27+
- <doc:Intersperse>
28+
- <doc:Joined>
29+
- <doc:Lazy>
30+
- <doc:Merge>
31+
- <doc:Reductions>
32+
- <doc:RemoveDuplicates>
33+
- <doc:Select>
34+
- <doc:Throttle>
35+
- <doc:Timer>
36+
- <doc:Zip>

0 commit comments

Comments
 (0)