Skip to content
Permalink
Browse files

API docs: repo switcher

Motivation:

API docs should be cross-linked.

Modifications:

Cross-link them.

Result:

better API docs
  • Loading branch information...
weissi committed Mar 28, 2019
1 parent 65d6f63 commit 8e59048aaff174b65c64ed27f4f79f8663058498
Showing with 13 additions and 1 deletion.
  1. +13 −1 scripts/generate_docs.sh
@@ -59,7 +59,7 @@ jazzy_args=(--clean
--github_url https://github.com/apple/swift-nio
--theme fullwidth
--xcodebuild-arguments -scheme,swift-nio-Package)
cat > "$module_switcher" <<EOF
cat > "$module_switcher" <<"EOF"
# SwiftNIO Docs
SwiftNIO contains multiple modules:
@@ -70,6 +70,18 @@ for module in "${modules[@]}"; do
echo " - [$module](../$module/index.html)" >> "$module_switcher"
done

cat >> "$module_switcher" <<"EOF"
---
For the API documentation of the other repositories in the SwiftNIO family check:
- [`swift-nio` API docs](https://apple.github.io/swift-nio/docs/current/NIO/index.html)
- [`swift-nio-ssl` API docs](https://apple.github.io/swift-nio-ssl/docs/current/NIOSSL/index.html)
- [`swift-nio-http2` API docs](https://apple.github.io/swift-nio-http2/docs/current/NIOHTTP2/index.html)
EOF

for module in "${modules[@]}"; do
args=("${jazzy_args[@]}" --output "$root_path/docs/$version/$module" --module "$module"
--module-version $version

0 comments on commit 8e59048

Please sign in to comment.
You can’t perform that action at this time.