Skip to content

Commit

Permalink
[feat] generate static web documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
matejmolnar committed Jan 23, 2024
1 parent 36afa70 commit 646971a
Show file tree
Hide file tree
Showing 763 changed files with 1,186 additions and 1 deletion.
18 changes: 18 additions & 0 deletions Package.resolved
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,24 @@
"version" : "1.2.3"
}
},
{
"identity" : "swift-docc-plugin",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-plugin",
"state" : {
"revision" : "26ac5758409154cc448d7ab82389c520fa8a8247",
"version" : "1.3.0"
}
},
{
"identity" : "swift-docc-symbolkit",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-symbolkit",
"state" : {
"revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
"version" : "1.0.0"
}
},
{
"identity" : "swift-syntax",
"kind" : "remoteSourceControl",
Expand Down
5 changes: 4 additions & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ let package = Package(
targets: ["Networking"]
)
],
dependencies: [.package(url: "https://github.com/realm/SwiftLint.git", exact: "0.53.0")],
dependencies: [
.package(url: "https://github.com/realm/SwiftLint.git", exact: "0.53.0"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
],
targets: [
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
// Targets can depend on other targets in this package, and on products in packages this package depends on.
Expand Down
9 changes: 9 additions & 0 deletions docs/css/chunk-c0335d80.10a2f091.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic.1d1eec04.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic~topic.b6287bcf.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/index.038e887c.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/topic.d8c126f3.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/tutorials-overview.c249c765.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/data/documentation/networking.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/data/documentation/networking/apimanager.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"article","metadata":{"title":"APIManaging Implementations","role":"collectionGroup","modules":[{"name":"Networking"}]},"hierarchy":{"paths":[["doc:\/\/Networking\/documentation\/Networking","doc:\/\/Networking\/documentation\/Networking\/APIManager"]]},"sections":[],"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/Networking\/documentation\/Networking\/APIManager\/defaultDecoder"]},{"generated":true,"identifiers":["doc:\/\/Networking\/documentation\/Networking\/APIManager\/request(_:)","doc:\/\/Networking\/documentation\/Networking\/APIManager\/request(_:decoder:retryConfiguration:)","doc:\/\/Networking\/documentation\/Networking\/APIManager\/request(_:retryConfiguration:)-9esih"],"title":"Instance Methods"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/networking\/apimanager\/apimanaging-implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/Networking\/documentation\/Networking\/APIManager\/APIManaging-Implementations"},"references":{"doc://Networking/documentation/Networking/Requestable":{"abstract":[{"type":"text","text":"A type that represents an API endpoint."}],"type":"topic","identifier":"doc:\/\/Networking\/documentation\/Networking\/Requestable","url":"\/documentation\/networking\/requestable","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Requestable"}],"title":"Requestable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"kind":"symbol"},"doc://Networking/documentation/Networking/APIManager/defaultDecoder":{"url":"\/documentation\/networking\/apimanager\/defaultdecoder","kind":"symbol","role":"symbol","abstract":[{"text":"Default JSONDecoder implementation.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"defaultDecoder","kind":"identifier"},{"text":": ","kind":"text"},{"text":"JSONDecoder","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation11JSONDecoderC"}],"type":"topic","title":"defaultDecoder","identifier":"doc:\/\/Networking\/documentation\/Networking\/APIManager\/defaultDecoder"},"doc://Networking/documentation/Networking/APIManager/request(_:retryConfiguration:)-9esih":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"request","kind":"identifier"},{"text":"<","kind":"text"},{"text":"DecodableResponse","kind":"genericParameter"},{"text":">(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Networking11RequestableP","text":"Requestable"},{"kind":"text","text":", "},{"text":"retryConfiguration","kind":"externalParam"},{"kind":"text","text":": "},{"text":"RetryConfiguration","preciseIdentifier":"s:10Networking18RetryConfigurationV","kind":"typeIdentifier"},{"kind":"text","text":"?) "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"DecodableResponse","kind":"typeIdentifier"}],"url":"\/documentation\/networking\/apimanager\/request(_:retryconfiguration:)-9esih","title":"request(_:retryConfiguration:)","abstract":[{"text":"Simplifies request using a default ","type":"text"},{"code":"JSONDecoder","type":"codeVoice"},{"text":".","type":"text"}],"type":"topic","role":"symbol","kind":"symbol","identifier":"doc:\/\/Networking\/documentation\/Networking\/APIManager\/request(_:retryConfiguration:)-9esih"},"doc://Networking/documentation/Networking/APIManager/request(_:decoder:retryConfiguration:)":{"identifier":"doc:\/\/Networking\/documentation\/Networking\/APIManager\/request(_:decoder:retryConfiguration:)","role":"symbol","title":"request(_:decoder:retryConfiguration:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"request"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"DecodableResponse"},{"kind":"text","text":">("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Networking11RequestableP","text":"Requestable"},{"kind":"text","text":", "},{"kind":"externalParam","text":"decoder"},{"text":": ","kind":"text"},{"text":"JSONDecoder","preciseIdentifier":"s:10Foundation11JSONDecoderC","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"retryConfiguration","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Networking18RetryConfigurationV","text":"RetryConfiguration","kind":"typeIdentifier"},{"text":"?) ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"DecodableResponse"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Creates a network request for an API endpoint defined by "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Networking\/documentation\/Networking\/Requestable"},{"type":"text","text":"."},{"type":"text","text":" "},{"text":"Default implementation trying to decode data from response.","type":"text"}],"url":"\/documentation\/networking\/apimanager\/request(_:decoder:retryconfiguration:)"},"doc://Networking/documentation/Networking/RetryConfiguration":{"identifier":"doc:\/\/Networking\/documentation\/Networking\/RetryConfiguration","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"RetryConfiguration","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"RetryConfiguration","kind":"identifier"}],"abstract":[{"text":"Retry of API calls allows various options wrapped into ","type":"text"},{"type":"codeVoice","code":"RetryConfiguration"},{"text":" struct.","type":"text"}],"kind":"symbol","role":"symbol","title":"RetryConfiguration","url":"\/documentation\/networking\/retryconfiguration"},"doc://Networking/documentation/Networking/APIManager/request(_:)":{"title":"request(_:)","type":"topic","role":"symbol","identifier":"doc:\/\/Networking\/documentation\/Networking\/APIManager\/request(_:)","kind":"symbol","url":"\/documentation\/networking\/apimanager\/request(_:)","abstract":[{"text":"Simplifies request using a default ","type":"text"},{"identifier":"doc:\/\/Networking\/documentation\/Networking\/RetryConfiguration","isActive":true,"type":"reference"},{"type":"text","text":"."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"request","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Requestable","preciseIdentifier":"s:10Networking11RequestableP"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:10Networking8Responsea","text":"Response","kind":"typeIdentifier"}]},"doc://Networking/documentation/Networking":{"type":"topic","title":"Networking","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/Networking\/documentation\/Networking","url":"\/documentation\/networking"},"doc://Networking/documentation/Networking/APIManager":{"role":"symbol","navigatorTitle":[{"text":"APIManager","kind":"identifier"}],"identifier":"doc:\/\/Networking\/documentation\/Networking\/APIManager","kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIManager","kind":"identifier"}],"url":"\/documentation\/networking\/apimanager","abstract":[{"text":"Default API manager which is responsible for the creation and management of network requests.","type":"text"}],"title":"APIManager","type":"topic"}}}
Loading

0 comments on commit 646971a

Please sign in to comment.