Merge branch 'gh-pages-branch' into main

.scripts/functions.sh

@@ -31,7 +31,6 @@ env::setup() {
     log::info "BUILD_DIRECTORY=$BUILD_DIRECTORY"
     export RUST_TOOLCHAIN=${RUST_TOOLCHAIN:-'nightly-2024-06-30'}
     log::info "RUST_TOOLCHAIN=$RUST_TOOLCHAIN"
-
     export CHECKOUTS_DIRECTORY=${CHECKOUTS_DIRECTORY:-"$ROOT_DIRECTORY/.build/checkouts"}
     log::info "CHECKOUTS_DIRECTORY=$CHECKOUTS_DIRECTORY"
     export FFI_DIRECTORY=${FFI_DIRECTORY:-"$CHECKOUTS_DIRECTORY/smoldot-c-ffi"}

Package.swift

@@ -14,6 +14,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/finsig/json-rpc2", from: "0.1.1")
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
     ],
     targets: [
         .target(
@@ -32,10 +33,10 @@ let package = Package(
         ///
         /// - IMPORTANT: When editing this file manually, use a single line of code (newline terminated) for the binary target. This preserves/simplifies sed script compatibility.
         ///
-        
+
         /// Release
         .binaryTarget(name: "smoldot", url: "https://github.com/finsig/smoldot-swift/releases/download/v0.1.0/smoldot.xcframework.zip", checksum: "7aff9a11e6333d214e8d7975d388766c591e1165506af382c356b3aff6898210"),
-        
+
         /// Development
         /*.binaryTarget(name: "smoldot", path: "Libs/smoldot.xcframework"),*/
 

README.md

@@ -17,11 +17,11 @@ A Chain Specification file must be provided to initialize a chain. A Chain Speci
 
 *Example Chain Specification JSON files for Polkadot, Kusama, Rococo, and Westend can be copied for use from [/Tests/SmoldotSwiftTests/Resources](https://github.com/loopedresolve/smoldot-swift/tree/main/Tests/SmoldotSwiftTests/Resources).*
 
-
 Initialize a chain from a specification file:
 
 ```swift
 var chain = Chain(specificationFile: {Resource file URL})
+
 ```
 
 Add the chain to the client to connect to the network:
@@ -91,3 +91,4 @@ In addition to unit tests please see this [project](https://github.com/finsig/sm
 ## Bug Reports
 
 See [GitHub issues](https://github.com/finsig/smoldot-swift/issues) regarding log noise.
+

build_docs.sh

@@ -0,0 +1,7 @@
+#! /bin/zsh -e
+
+swift package --allow-writing-to-directory ./docs \
+    generate-documentation --target SmoldotSwift --output-path ./docs \
+    --disable-indexing \
+    --transform-for-static-hosting \
+    --hosting-base-path smoldot-swift

docs/data/documentation/smoldotswift.json

@@ -0,0 +1 @@
+{"metadata":{"modules":[{"name":"SmoldotSwift"}],"title":"SmoldotSwift","roleHeading":"Framework","role":"collection","externalID":"SmoldotSwift","symbolKind":"module"},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[[]]},"topicSections":[{"identifiers":["doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/Chain","doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/Client"],"title":"Classes"},{"identifiers":["doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/ClientError"],"title":"Structures"},{"title":"Type Aliases","identifiers":["doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/JSONObject","doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/JSONRPC2Request"]},{"title":"Extended Modules","identifiers":["doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/Swift"]}],"kind":"symbol","variants":[{"paths":["\/documentation\/smoldotswift"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift","interfaceLanguage":"swift"},"references":{"doc://SmoldotSwift/documentation/SmoldotSwift/JSONObject":{"url":"\/documentation\/smoldotswift\/jsonobject","abstract":[{"type":"text","text":"JSON object"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/JSONObject","navigatorTitle":[{"kind":"identifier","text":"JSONObject"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JSONObject"}],"type":"topic","title":"JSONObject"},"doc://SmoldotSwift/documentation/SmoldotSwift/Client":{"title":"Client","abstract":[{"type":"text","text":"A client that is used to connect to Polkadot-based blockchain networks."}],"role":"symbol","navigatorTitle":[{"text":"Client","kind":"identifier"}],"type":"topic","url":"\/documentation\/smoldotswift\/client","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Client","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/Client"},"doc://SmoldotSwift/documentation/SmoldotSwift/Swift":{"type":"topic","kind":"symbol","title":"Swift","identifier":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/Swift","url":"\/documentation\/smoldotswift\/swift","abstract":[],"role":"collection"},"doc://SmoldotSwift/documentation/SmoldotSwift/Chain":{"identifier":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/Chain","kind":"symbol","url":"\/documentation\/smoldotswift\/chain","role":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Chain","kind":"identifier"}],"abstract":[{"type":"text","text":"A model representing a Polkadot-based blockchain network."}],"type":"topic","navigatorTitle":[{"text":"Chain","kind":"identifier"}],"title":"Chain"},"doc://SmoldotSwift/documentation/SmoldotSwift":{"role":"collection","type":"topic","title":"SmoldotSwift","kind":"symbol","url":"\/documentation\/smoldotswift","abstract":[],"identifier":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift"},"doc://SmoldotSwift/documentation/SmoldotSwift/ClientError":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"ClientError","kind":"identifier"}],"navigatorTitle":[{"text":"ClientError","kind":"identifier"}],"title":"ClientError","url":"\/documentation\/smoldotswift\/clienterror","kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/ClientError","abstract":[]},"doc://SmoldotSwift/documentation/SmoldotSwift/JSONRPC2Request":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JSONRPC2Request"}],"navigatorTitle":[{"text":"JSONRPC2Request","kind":"identifier"}],"title":"JSONRPC2Request","url":"\/documentation\/smoldotswift\/jsonrpc2request","kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/SmoldotSwift\/documentation\/SmoldotSwift\/JSONRPC2Request","abstract":[{"type":"text","text":"JSONRPC2Request"}]}}}