Skip to content

Commit 55be678

Browse files
authored
docs: Use swift-docc-plugin to preview documentation (#95)
### Motivation Makes it easier to preview documentation changes ### Modifications * Add dependency on swift-docc-plugin * Add detail on how to preview into the README within the documentation target ### Result Documentation changes can be previewed by running the following command: ``` swift package --disable-sandbox preview-documentation --target ContainerImageBuilderPlugin ``` ### Test Plan No functional change.
1 parent 7229c3a commit 55be678

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

Package.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ let package = Package(
2727
.package(url: "https://github.com/apple/swift-crypto.git", "1.0.0"..<"4.0.0"),
2828
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"),
2929
.package(url: "https://github.com/apple/swift-http-types.git", from: "1.2.0"),
30+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
3031
],
3132
targets: [
3233
.target(

Sources/ContainerImageBuilderPluginDocumentation/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,10 @@
33
`ContainerImageBuilderPluginDocumentation` is an otherwise empty target that includes high-level,
44
user-facing documentation about using the ContainerImageBuilder plugin from the command-line.
55

6+
To preview the documentation, run the following command:
7+
8+
```bash
9+
swift package --disable-sandbox preview-documentation --target ContainerImageBuilderPlugin
10+
```
11+
612
<!-- Copyright (c) 2024 Apple Inc and the Swift Project authors. All Rights Reserved. -->

0 commit comments

Comments
 (0)