Skip to content

Commit

Permalink
Documentation: added reference to new View.debugRevenueCatOverlay
Browse files Browse the repository at this point in the history
  • Loading branch information
NachoSoto committed Jun 9, 2023
1 parent 5186595 commit 2074c27
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ var dependencies: [Package.Dependency] = [
.package(url: "git@github.com:Quick/Nimble.git", from: "10.0.0")
]
if shouldIncludeDocCPlugin {
dependencies.append(.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"))
dependencies.append(.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.2.0"))
}

let package = Package(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Most features require configuring the SDK before using it.
- ``Purchases/configure(withAPIKey:)``
- ``Purchases/configure(with:)-6oipy``
- ``PurchasesDiagnostics``
- ``SwiftUI/View/debugRevenueCatOverlay()``

### Displaying Products
- ``Purchases/offerings()``
Expand Down
12 changes: 11 additions & 1 deletion fastlane/Fastfile
Original file line number Diff line number Diff line change
Expand Up @@ -507,12 +507,14 @@ platform :ios do
sh("swift",
"build",
"--target", "RevenueCat",
"--configuration", "debug", # Necessary for debug-only symbols
# Build for iOS instead of the default macOS. This ensures that iOS-only symbols are included in the docs.
"-Xswiftc", "-sdk", "-Xswiftc", sh("xcrun", "--sdk", "iphonesimulator", "--show-sdk-path").strip!,
"-Xswiftc", "-target", "-Xswiftc", "x86_64-apple-ios#{ios_version}-simulator",
"-Xswiftc", "-emit-symbol-graph",
"-Xswiftc", "-emit-symbol-graph-dir",
"-Xswiftc", ".build")
"-Xswiftc", ".build",
"-Xswiftc", "-emit-extension-block-symbols")
end

desc "Preview docs"
Expand All @@ -529,10 +531,14 @@ platform :ios do
"preview-documentation",
"--target",
"RevenueCat",
"--configuration",
"debug", # Necessary for debug-only symbols
"--platform",
"name=iOS,version=#{ios_version}",
"--transform-for-static-hosting",
"--enable-inherited-docs",
# Note: this is becoming the default on Swift 5.9: https://github.com/apple/swift-docc-plugin/commit/26ac5758409154cc448d7ab82389c520fa8a8247
"--include-extended-types",
"--additional-symbol-graph-dir", ".build")
end
end
Expand Down Expand Up @@ -566,6 +572,8 @@ platform :ios do
"generate-documentation",
"--target",
"RevenueCat",
"--configuration",
"debug", # Necessary for debug-only symbols
"--disable-indexing", # Produces a DocC archive that is best-suited for hosting online but incompatible with Xcode.
"--platform",
"name=iOS,version=#{ios_version}",
Expand All @@ -575,6 +583,8 @@ platform :ios do
hosting_base_path,
"--transform-for-static-hosting",
"--enable-inherited-docs",
# Note: this is becoming the default on Swift 5.9: https://github.com/apple/swift-docc-plugin/commit/26ac5758409154cc448d7ab82389c520fa8a8247
"--include-extended-types",
"--additional-symbol-graph-dir", ".build")

docs_index_path = File.join(Dir.pwd, "scripts/docs/index.html")
Expand Down

0 comments on commit 2074c27

Please sign in to comment.