Skip to content

Commit 845a97c

Browse files
authored
Remove Jazzy doc generation (#417)
Motivation: Docs are generated by and hosted on the Swift Package Index. We no longer need the script to generate docs via Jazzy. Modifications: - Remove the generate_docs script - Remove Jazzy from the Dockerfile but keep Ruby; it's used for generating test manifests. - Remove SwiftFormat from the Dockerfile; we don't use it. Result: Fewer unused things.
1 parent d160fba commit 845a97c

File tree

2 files changed

+1
-136
lines changed

2 files changed

+1
-136
lines changed

docker/Dockerfile

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,8 @@ RUN apt-get update && apt-get install -y lsof dnsutils netcat-openbsd net-tools
1818
RUN apt-get update && apt-get install -y libssl-dev
1919
RUN apt-get update && apt-get install -y execstack
2020

21-
# ruby and jazzy for docs generation
21+
# ruby for soundness
2222
RUN apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev build-essential
23-
# jazzy no longer works on xenial as ruby is too old.
24-
RUN if [ "${ubuntu_version}" = "focal" ] ; then echo "gem: --no-document" > ~/.gemrc ; fi
25-
RUN if [ "${ubuntu_version}" = "focal" ] ; then gem install jazzy ; fi
2623

2724
# tools
2825
RUN mkdir -p $HOME/.tools
@@ -31,10 +28,3 @@ RUN echo 'export PATH="$HOME/.tools:$PATH"' >> $HOME/.profile
3128
# script to allow mapping framepointers on linux (until part of the toolchain)
3229
RUN wget -q https://raw.githubusercontent.com/apple/swift/main/utils/symbolicate-linux-fatal -O $HOME/.tools/symbolicate-linux-fatal
3330
RUN chmod 755 $HOME/.tools/symbolicate-linux-fatal
34-
35-
# swiftformat (until part of the toolchain)
36-
37-
ARG swiftformat_version=0.40.12
38-
RUN git clone --branch $swiftformat_version --depth 1 https://github.com/nicklockwood/SwiftFormat $HOME/.tools/swift-format
39-
RUN cd $HOME/.tools/swift-format && swift build -c release
40-
RUN ln -s $HOME/.tools/swift-format/.build/release/swiftformat $HOME/.tools/swiftformat

scripts/generate_docs.sh

Lines changed: 0 additions & 125 deletions
This file was deleted.

0 commit comments

Comments
 (0)