Merge pull request #21 from tayloraswift/validate-docs

Author: tayloraswift

.github/workflows/build.yml

@@ -10,47 +10,49 @@ jobs:
     build-macos:
         runs-on: macos-14
         steps:
-          - uses: actions/checkout@v3
-          - uses: SwiftyLab/setup-swift@latest
-            with:
-              swift-version: "5.10.0"
-          - name: build
-            run: |
-              swift --version
-              swift build
-              swift test
+            -   name: Checkout repository
+                uses: actions/checkout@v3
+
+            -   name: build
+                run: |
+                    swift --version
+                    swift build
+                    swift test
 
     benchmark-macos:
         runs-on: macos-14
         steps:
-          - uses: actions/checkout@v3
-          - uses: SwiftyLab/setup-swift@latest
-            with:
-              swift-version: "5.10.0"
-          - name: Homebrew Mac
-            if: ${{ runner.os == 'Macos' }}
-            run: |
-              echo "/opt/homebrew/bin:/usr/local/bin" >> $GITHUB_PATH
-              brew install jemalloc
-          - name: Ubuntu deps
-            if: ${{ runner.os == 'Linux' }}
-            run: |
-              sudo apt-get install -y libjemalloc-dev
-          - name: benchmark
-            run: |
-              cd ExternalBenchmarks
-              swift package benchmark
+            -   name: Checkout repository
+                uses: actions/checkout@v3
+
+            -   name: Homebrew Mac
+                if: ${{ runner.os == 'Macos' }}
+                run: |
+                    echo "/opt/homebrew/bin:/usr/local/bin" >> $GITHUB_PATH
+                    brew install jemalloc
+            -   name: Ubuntu deps
+                if: ${{ runner.os == 'Linux' }}
+                run: |
+                    sudo apt-get install -y libjemalloc-dev
+            -   name: benchmark
+                run: |
+                    cd ExternalBenchmarks
+                    swift package benchmark
 
     build-linux:
-        runs-on: ubuntu-22.04
+        runs-on: ubuntu-24.04
         steps:
-            - uses: actions/checkout@v3
-            - uses: SwiftyLab/setup-swift@latest
-              with:
-                swift-version: "5.10.0"
-            - name: build
-              run: |
-                swift --version
-                swift build
-                swift build -c release
-                swift test
+            -   name: Install Swift
+                uses: tayloraswift/swift-install-action@master
+                with:
+                    swift-prefix: "swift-5.10.1-release/ubuntu2404/swift-5.10.1-RELEASE"
+                    swift-id: "swift-5.10.1-RELEASE-ubuntu24.04"
+
+            -   name: Checkout repository
+                uses: actions/checkout@v3
+
+            -   name: Build and test
+                run: |
+                    swift --version
+                    swift build -c release
+                    swift test

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+# This workflow validates the package’s documentation. Because documentation building involves
+# compiling the package, this also checks that the package itself compiles successfully on each
+# supported platform.
+name: documentation
+
+on:
+    push:
+        branches: [ master ]
+    pull_request:
+        branches: [ master ]
+
+jobs:
+    linux:
+        runs-on: ubuntu-24.04
+        name: Ubuntu 24.04
+
+        steps:
+            -   name: Install Swift
+                uses: tayloraswift/swift-install-action@master
+                with:
+                    swift-prefix: "swift-5.10.1-release/ubuntu2404/swift-5.10.1-RELEASE"
+                    swift-id: "swift-5.10.1-RELEASE-ubuntu24.04"
+
+            -   name: Install Unidoc
+                uses: tayloraswift/swift-unidoc-action@master
+                with:
+                    unidoc-version: "master"
+
+            #   This clobbers everything in the current directory!
+            -   name: Checkout repository
+                uses: actions/checkout@v3
+
+            -   name: Validate documentation
+                run: |
+                    unidoc compile -I .. \
+                    --swift-toolchain $SWIFT_INSTALLATION \
+                    --ci fail-on-errors \
+                    --package-name swift-noise
+
+    macos:
+        runs-on: macos-14
+        name: macOS
+        env:
+            DEVELOPER_DIR: "/Applications/Xcode_15.3.app/Contents/Developer"
+
+        steps:
+            -   name: Install Unidoc
+                uses: tayloraswift/swift-unidoc-action@master
+                with:
+                    unidoc-version: "master"
+
+            -   name: Checkout repository
+                uses: actions/checkout@v3
+
+            -   name: Validate documentation
+                run: |
+                    unidoc compile -I .. \
+                    --ci fail-on-errors \
+                    --package-name swift-noise

ExternalBenchmarks/Package.swift

@@ -5,7 +5,7 @@ import PackageDescription
 let package = Package(
     name: "ExternalBenchmarks",
     platforms: [
-        .macOS(.v13),
+        .macOS("13.3"),
     ],
     dependencies: [
         .package(url: "https://github.com/ordo-one/package-benchmark", .upToNextMajor(from: "1.0.0")),

Package.resolved

@@ -4,17 +4,17 @@ import PackageDescription
 
 let package = Package(
     name: "swift-noise",
-    platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6)],
-    products: 
+    platforms: [.macOS("13.3"), .iOS("16.4"), .tvOS("16.4"), .watchOS("9.4")],
+    products:
     [
         .library(name: "Noise", targets: ["Noise"]),
         .executable(name: "generate-noise", targets: ["GenNoise"])
     ],
-    dependencies: 
+    dependencies:
     [
         .package(url: "https://github.com/tayloraswift/swift-png", from: "4.4.0")
     ],
-    targets: 
+    targets:
     [
         .target(
             name: "Noise"

Package.swift

@@ -3,6 +3,8 @@
 ***`noise`***<br>`2.0`
 
 [![ci build status](https://github.com/tayloraswift/swift-noise/actions/workflows/build.yml/badge.svg)](https://github.com/tayloraswift/swift-noise/actions/workflows/build.yml)
+[![ci build status](https://github.com/tayloraswift/swift-noise/actions/workflows/docs.yml/badge.svg)](https://github.com/tayloraswift/swift-noise/actions/workflows/docs.yml)
+
 [![swift package index versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ftayloraswift%2Fswift-noise%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/tayloraswift/swift-noise)
 [![swift package index platforms](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ftayloraswift%2Fswift-noise%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/tayloraswift/swift-noise)
 

README.md

@@ -565,7 +565,7 @@ extension _CellNoise3D
 /// `CellNoise3D` is analogous to
 /// [Blender Voronoi noise](https://docs.blender.org/manual/en/dev/render/cycles/nodes/types/textures/voronoi.html),
 /// with the *Distance Squared* metric. The *Scale* of Blender Voronoi noise is identical to the
-/// ``frequency`` of `CellNoise3D`; its range is approximately `0 ... 10/3` in `CellNoise3D`
+/// frequency of `CellNoise3D`; its range is approximately `0 ... 10/3` in `CellNoise3D`
 /// units.
 public
 struct CellNoise3D:_CellNoise3D, HashedNoise