From 85c553167ea821b010bdbf70fabcd8d285d8745f Mon Sep 17 00:00:00 2001 From: tomer doron Date: Wed, 1 Sep 2021 14:33:52 -0700 Subject: [PATCH] fix doc generation and jazzy version motivation: fix ci changes: * only install ruby and jazzy on focal since jazzy id not supported onlder versions of ubuntu * fix doc generations script adjusting it to latest source-kittent syntax --- .SourceKitten | 1 + docker/Dockerfile | 7 +++---- scripts/generate_docs.sh | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) create mode 160000 .SourceKitten diff --git a/.SourceKitten b/.SourceKitten new file mode 160000 index 0000000..9c254b5 --- /dev/null +++ b/.SourceKitten @@ -0,0 +1 @@ +Subproject commit 9c254b5be7248f406bcafd36d670614b7f067632 diff --git a/docker/Dockerfile b/docker/Dockerfile index 7cd7b26..400d61c 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -18,11 +18,10 @@ RUN apt-get update && apt-get install -y lsof dnsutils netcat-openbsd net-tools RUN apt-get update && apt-get install -y zlib1g-dev # ruby and jazzy for docs generation -RUN apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev build-essential -# switch off gem docs building -RUN echo "gem: --no-document" > ~/.gemrc # jazzy no longer works on xenial as ruby is too old. -RUN if [ "${ubuntu_version}" != "xenial" ] ; then gem install jazzy; fi +RUN if [ "${ubuntu_version}" = "focal" ] ; then apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev build-essential ; fi +RUN if [ "${ubuntu_version}" = "focal" ] ; then echo "gem: --no-document" > ~/.gemrc ; fi +RUN if [ "${ubuntu_version}" = "focal" ] ; then gem install jazzy ; fi # tools RUN mkdir -p $HOME/.tools diff --git a/scripts/generate_docs.sh b/scripts/generate_docs.sh index d645eb6..827a6bb 100755 --- a/scripts/generate_docs.sh +++ b/scripts/generate_docs.sh @@ -30,7 +30,7 @@ if [[ "$(uname -s)" == "Linux" ]]; then if [[ ! -d "$source_kitten_source_path" ]]; then git clone https://github.com/jpsim/SourceKitten.git "$source_kitten_source_path" fi - source_kitten_path="$source_kitten_source_path/.build/x86_64-unknown-linux/debug" + source_kitten_path="$source_kitten_source_path/.build/debug" if [[ ! -d "$source_kitten_path" ]]; then rm -rf "$source_kitten_source_path/.swift-version" cd "$source_kitten_source_path" && swift build && cd "$root_path" @@ -39,7 +39,7 @@ if [[ "$(uname -s)" == "Linux" ]]; then mkdir -p "$root_path/.build/sourcekitten" for module in "${modules[@]}"; do if [[ ! -f "$root_path/.build/sourcekitten/$module.json" ]]; then - "$source_kitten_path/sourcekitten" doc --spm-module $module > "$root_path/.build/sourcekitten/$module.json" + "$source_kitten_path/sourcekitten" doc --module-name $module > "$root_path/.build/sourcekitten/$module.json" fi done fi