Skip to content

Commit

Permalink
We no longer require the docc plugin (#208)
Browse files Browse the repository at this point in the history
Motivation:

Swift Package Index builds our docs for us and will automatically insert
the dependency.

Modifications:

- Remove the docc-plugin dependency

Result:

Fewer dependencies
  • Loading branch information
glbrntt authored Oct 3, 2024
1 parent afd1691 commit dbace16
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
1 change: 0 additions & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ let package = Package(
dependencies: [
.package(url: "https://github.com/apple/swift-nio.git", from: "2.62.0"),
.package(url: "https://github.com/apple/swift-atomics.git", from: "1.0.2"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
],
targets: [
.target(
Expand Down
3 changes: 3 additions & 0 deletions scripts/check-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ set -eu
raw_targets=$(sed -E -n -e 's/^.* - documentation_targets: \[(.*)\].*$/\1/p' .spi.yml)
targets=(${raw_targets//,/ })

# Add the DocC plugin; the doc checking CI runs on 5.8 so we can't use "swift package add-dependency".
echo 'package.dependencies.append(.package(url: "https://github.com/apple/swift-docc-plugin.git", from: "1.0.0"))' >> Package.swift

for target in "${targets[@]}"; do
swift package plugin generate-documentation --target "$target" --warnings-as-errors --analyze --level detailed
done

0 comments on commit dbace16

Please sign in to comment.