Skip to content

Commit

Permalink
Link to docs in GH Pages (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
davdroman authored Nov 11, 2022
1 parent 312c8fa commit 01af58e
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 290 deletions.
4 changes: 1 addition & 3 deletions .spi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ builder:
configs:
- platform: ios
scheme: NavigationTransitions
documentation_targets: [NavigationTransitions, NavigationTransition, AtomicTransition, Animator, Animation]
- platform: macos-xcodebuild
scheme: NavigationTransitions
documentation_targets: [NavigationTransitions]
- platform: tvos
scheme: NavigationTransitions
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The library ships with some **standard transitions** out of the box:
- [`fade(_:)`](Sources/NavigationTransition/Fade.swift)
- [`slide(axis:)`](Sources/NavigationTransition/Slide.swift)

In addition to these, you can create fully [**custom**](Demo/Demo/Swing.swift) transitions in just a few lines of SwiftUI-like code!
In addition to these, you can create fully [**custom transitions**](https://davdroman.github.io/swiftui-navigation-transitions/main/documentation/navigationtransitions/custom-transitions/) in just a few lines of SwiftUI-like code!

```swift
struct Swing: NavigationTransition {
Expand Down Expand Up @@ -105,8 +105,6 @@ struct Swing: NavigationTransition {
}
```

Check out the [**documentation**](Documentation/Custom-Transitions.md) to learn more about custom transitions.

The [**Demo**](Demo) app showcases some of these transitions in action.

### Interactivity
Expand All @@ -127,8 +125,8 @@ This even works to override its behavior while maintaining the **default system

The documentation for releases and `main` are available here:

- [`main`](https://swiftpackageindex.com/davdroman/swiftui-navigation-transitions/main/documentation/navigationtransitions)
- [0.2.0](https://swiftpackageindex.com/davdroman/swiftui-navigation-transitions/0.2.0/documentation/navigationtransitions)
- [`main`](https://davdroman.github.io/swiftui-navigation-transitions/main/documentation/navigationtransitions/)
- [0.5.0](https://davdroman.github.io/swiftui-navigation-transitions/0.5.0/documentation/navigationtransitions/)

The repository also contains [**documentation**](Documentation/Custom-Transitions.md) covering how to set up your own **custom transitions**.

Expand Down
282 changes: 0 additions & 282 deletions Sources/NavigationTransition/Documentation.docc/Custom-Transitions.md

This file was deleted.

File renamed without changes.
3 changes: 3 additions & 0 deletions Sources/NavigationTransitions/_Exports.swift
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
@_exported import Animation
@_exported import Animator
@_exported import AtomicTransition
@_exported import NavigationTransition
16 changes: 16 additions & 0 deletions scripts/generate-docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/usr/bin/env bash

killall Xcode

xcodebuild docbuild \
-scheme NavigationTransitions \
-destination generic/platform=iOS \
OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path /swiftui-navigation-transitions/$1 --output-path $1"

git checkout docs

git add .
git commit -m "Generate docs for $1"
git push origin docs

git checkout -

0 comments on commit 01af58e

Please sign in to comment.