Skip to content

Commit 8d513d8

Browse files
committed
Disfavor deprecated DocumentationBundle init
1 parent 013ceb4 commit 8d513d8

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

Sources/SwiftDocC/Infrastructure/DocumentationBundle.swift

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,9 @@ public struct DocumentationBundle {
158158
self.articlesDocumentationRootReference = documentationRootReference.appendingPath(urlReadablePath(info.displayName))
159159
}
160160

161-
@available(*, deprecated, renamed: "init(info:baseURL:symbolGraphURLs:markupURLs:miscResourceURLs:customHeader:customFooter:themeSettings:)", message: "Use 'init(info:baseURL:symbolGraphURLs:markupURLs:miscResourceURLs:customHeader:customFooter:themeSettings:)' instead. This deprecated API will be removed after 6.1 is released")
161+
162+
@_disfavoredOverload
163+
@available(*, deprecated, renamed: "init(info:baseURL:symbolGraphURLs:markupURLs:miscResourceURLs:customHeader:customFooter:themeSettings:customScripts:)", message: "Use 'init(info:baseURL:symbolGraphURLs:markupURLs:miscResourceURLs:customHeader:customFooter:themeSettings:customScripts:)' instead. This deprecated API will be removed after 6.1 is released")
162164
public init(
163165
info: Info,
164166
baseURL: URL = URL(string: "/")!,
@@ -170,7 +172,7 @@ public struct DocumentationBundle {
170172
customFooter: URL? = nil,
171173
themeSettings: URL? = nil
172174
) {
173-
self.init(info: info, baseURL: baseURL, symbolGraphURLs: symbolGraphURLs, markupURLs: markupURLs, miscResourceURLs: miscResourceURLs, customHeader: customHeader, customFooter: customFooter, themeSettings: themeSettings)
175+
self.init(info: info, baseURL: baseURL, symbolGraphURLs: symbolGraphURLs, markupURLs: markupURLs, miscResourceURLs: miscResourceURLs, customHeader: customHeader, customFooter: customFooter, themeSettings: themeSettings, customScripts: nil)
174176
self.attributedCodeListings = attributedCodeListings
175177
}
176178

Sources/SwiftDocC/Infrastructure/Input Discovery/DocumentationInputsProvider.swift

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,8 @@ extension DocumentationContext.InputsProvider {
165165
miscResourceURLs: foundContents.resources,
166166
customHeader: shallowContent.first(where: FileTypes.isCustomHeader),
167167
customFooter: shallowContent.first(where: FileTypes.isCustomFooter),
168-
themeSettings: shallowContent.first(where: FileTypes.isThemeSettingsFile)
168+
themeSettings: shallowContent.first(where: FileTypes.isThemeSettingsFile),
169+
customScripts: shallowContent.first(where: FileTypes.isCustomScriptsFile)
169170
)
170171
}
171172

0 commit comments

Comments
 (0)