Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepare documentation for 1.0 release #6

Merged
merged 1 commit into from
Mar 14, 2022
Merged

Prepare documentation for 1.0 release #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ Please see
[the plugin's documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
for more detailed usage instructions.

**Note:** The Swift-DocC plugin is under **active-development** and is not ready for production
use.

We anticipate releasing a `1.0` version of the Swift-DocC plugin aligned with
the release of Swift `5.6`.

Expand All @@ -24,16 +21,15 @@ let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
],
targets: [
// targets
]
)
```

Swift 5.6 is required in order to run the plugin. Development snapshots that include Swift 5.6
can be found on [Swift.org](https://www.swift.org/download/#snapshots).
Swift 5.6 is required in order to run the plugin.

### Converting Documentation

Expand Down
4 changes: 1 addition & 3 deletions ...ocumentation/SwiftDocCPlugin.docc/Getting Started with the Swift-DocC Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
],
targets: [
// targets
Expand All @@ -20,8 +20,6 @@ let package = Package(
```

> Important: Swift 5.6 is required in order to run the plugin.
> Development snapshots that include Swift 5.6
> can be found on [Swift.org](https://www.swift.org/download/#snapshots).

You can then invoke the plugin from the root of your repository like so:

Expand Down
6 changes: 0 additions & 6 deletions Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/SwiftDocCPlugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ Produce Swift-DocC documentation for Swift Package libraries and executables.
The Swift-DocC plugin is a Swift Package Manager command plugin that supports building
documentation for SwiftPM libraries and executables.

> Important: The Swift-DocC plugin is under **active-development** and is not ready for production
> use.
>
> We anticipate releasing a `1.0` version of the Swift-DocC plugin aligned with
> the release of Swift `5.6`.

After adding the plugin as a dependency in your Swift package manifest, you can build
documentation for the libraries and executables in that package and its dependencies by running the
following from the command-line:
Expand Down