From 6ad40ebe28976990d1e1f8176277120ece733ccd Mon Sep 17 00:00:00 2001 From: Finn Behrens Date: Fri, 11 Mar 2022 10:11:55 +0100 Subject: [PATCH 1/2] add swift doc plugin --- .gitignore | 2 ++ Package.resolved | 9 +++++++++ Package.swift | 1 + Sources/MatrixClient/MatrixClient.docc/MatrixClient.md | 4 ++++ 4 files changed, 16 insertions(+) diff --git a/.gitignore b/.gitignore index bb460e7..29c3c07 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ xcuserdata/ DerivedData/ .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata +doc/ + diff --git a/Package.resolved b/Package.resolved index 7309574..537833c 100644 --- a/Package.resolved +++ b/Package.resolved @@ -9,6 +9,15 @@ "revision": "b1a7a8a6186f2fcb28f7bda67cfc545de48b3c80", "version": "0.6.2" } + }, + { + "package": "SwiftDocCPlugin", + "repositoryURL": "https://github.com/apple/swift-docc-plugin", + "state": { + "branch": "main", + "revision": "8aca5c543da5f99dbfc8ff04e50c3ac870f8deca", + "version": null + } } ] }, diff --git a/Package.swift b/Package.swift index 57a387b..604f7cd 100644 --- a/Package.swift +++ b/Package.swift @@ -22,6 +22,7 @@ let package = Package( // Dependencies declare other packages that this package depends on. // .package(url: /* package url */, from: "1.0.0"), .package(url: "https://github.com/Flight-School/AnyCodable", from: "0.6.0"), + .package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"), ], targets: [ // Targets are the basic building blocks of a package. A target can define a module or a test suite. diff --git a/Sources/MatrixClient/MatrixClient.docc/MatrixClient.md b/Sources/MatrixClient/MatrixClient.docc/MatrixClient.md index 6639dcc..f3adaf2 100644 --- a/Sources/MatrixClient/MatrixClient.docc/MatrixClient.md +++ b/Sources/MatrixClient/MatrixClient.docc/MatrixClient.md @@ -1,5 +1,9 @@ # ``MatrixClient`` +@Metadata { + @TechnologyRoot +} + Matrix Client with Swift 5.5 async API. ## Overview From ffdc89f0d75367449b9da969700b1ea8184d7d30 Mon Sep 17 00:00:00 2001 From: Finn Behrens Date: Thu, 17 Mar 2022 15:33:05 +0100 Subject: [PATCH 2/2] add doc test version --- .github/workflows/doc.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/workflows/doc.yml diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000..228de66 --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,11 @@ +name: DocC +on: [push] +env: + DEVELOPER_DIR: /Applications/Xcode_13.3.app/Contents/Developer +jobs: + build: + runs-on: macos-12 + steps: + - uses: 'actions/checkout@v2' + - name: Build + run: swift package --allow-writing-to-directory doc generate-documentation --target MatrixClient --disable-indexing --output-path doc --transform-for-static-hosting