Skip to content

Commit

Permalink
Pass --module-version and --root-url parameters to jazzy (apple…
Browse files Browse the repository at this point in the history
…#700)

* Pass `--module-version` and `--root-url` parameters to `jazzy`

### Motivation:

It would be good if the API document was distributed as a docset that can be installed in Dash, like [Yams](https://www.jpsim.com/Yams/).

### Modifications:

Pass `--module-version` and `--root-url` parameters to `jazzy`.

### Result:

Jazzy generates docsets and add "Install in Dash" link to `index.html`.

* Apply review: Avoid appending `args`
  • Loading branch information
norio-nomura authored and weissi committed Dec 18, 2018
1 parent 0beabb6 commit 0a5f4b7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion scripts/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ for module in "${modules[@]}"; do
done

for module in "${modules[@]}"; do
args=("${jazzy_args[@]}" --output "$root_path/docs/$version/$module" --module "$module")
args=("${jazzy_args[@]}" --output "$root_path/docs/$version/$module" --module "$module"
--module-version $version
--root-url "https://apple.github.io/swift-nio/docs/$version/$module")
if [[ -f "$root_path/.build/sourcekitten/$module.json" ]]; then
args+=(--sourcekitten-sourcefile "$root_path/.build/sourcekitten/$module.json")
fi
Expand Down

0 comments on commit 0a5f4b7

Please sign in to comment.