Use Swift Package Index for docs
This commit is contained in:
parent
1522654b59
commit
0994810987
|
@ -1,22 +0,0 @@
|
|||
name: Generate documentation
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: macos-12
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: DocC
|
||||
run: >
|
||||
swift package --allow-writing-to-directory docs
|
||||
generate-documentation --target KeyboardShortcuts
|
||||
--disable-indexing
|
||||
--transform-for-static-hosting
|
||||
--hosting-base-path KeyboardShortcuts
|
||||
--output-path docs
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: '.'
|
|
@ -0,0 +1,4 @@
|
|||
version: 1
|
||||
builder:
|
||||
configs:
|
||||
- documentation_targets: ['KeyboardShortcuts']
|
|
@ -1,14 +0,0 @@
|
|||
{
|
||||
"pins" : [
|
||||
{
|
||||
"identity" : "swift-docc-plugin",
|
||||
"kind" : "remoteSourceControl",
|
||||
"location" : "https://github.com/apple/swift-docc-plugin",
|
||||
"state" : {
|
||||
"revision" : "3303b164430d9a7055ba484c8ead67a52f7b74f6",
|
||||
"version" : "1.0.0"
|
||||
}
|
||||
}
|
||||
],
|
||||
"version" : 2
|
||||
}
|
|
@ -15,9 +15,6 @@ let package = Package(
|
|||
]
|
||||
)
|
||||
],
|
||||
dependencies: [
|
||||
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
|
||||
],
|
||||
targets: [
|
||||
.target(
|
||||
name: "KeyboardShortcuts"
|
||||
|
|
|
@ -155,7 +155,7 @@ This package supports [localizations](/Sources/KeyboardShortcuts/Localization).
|
|||
|
||||
## API
|
||||
|
||||
[See the API docs.](https://sindresorhus.com/KeyboardShortcuts/documentation/keyboardshortcuts/keyboardshortcuts)
|
||||
[See the API docs.](https://swiftpackageindex.com/sindresorhus/keyboardshortcuts/main/documentation/keyboardshortcuts/keyboardshortcuts)
|
||||
|
||||
## Tips
|
||||
|
||||
|
|
Loading…
Reference in New Issue