Merge branch 'docc'

HOW_TO_MAKE_DOCC.md

@@ -0,0 +1,8 @@
+# How to make DocC Page
+
+1. Close this package
+2. Open a terminal and navigate to the root directory of this package.
+3. Execute the following commands
+``` zsh
+make docc
+```

Makefile

@@ -0,0 +1,16 @@
+DOCC_TARGET = ATProtoKit
+DOCC_DIR = ./docs
+
+.PHONY: docc
+docc:
+	swift package --allow-writing-to-directory $(DOCC_DIR) \
+		generate-documentation --target $(DOCC_TARGET) \
+		--disable-indexing \
+		--transform-for-static-hosting \
+		--hosting-base-path $(DOCC_TARGET) \
+		--output-path $(DOCC_DIR)
+
+.PHONY: docc-preview
+docc-preview:
+	swift package --disable-sandbox preview-documentation --target $(DOCC_TARGET)
+

Package.resolved

@@ -1,5 +1,23 @@
 {
   "pins" : [
+    {
+      "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" : "swiftsoup",
       "kind" : "remoteSourceControl",

Package.swift

@@ -19,6 +19,7 @@ let package = Package(
             targets: ["ATProtoKit"]),
     ],
     dependencies: [
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
         .package(url: "https://github.com/scinfu/SwiftSoup.git", from: "2.7.0")
     ],
     targets: [

docs/CNAME

@@ -0,0 +1 @@
+atprotokit.cjrriley.com

docs/data/documentation/atprotokit/actorgetpreferencesoutput.json

@@ -0,0 +1 @@
+{"abstract":[{"text":"A data model definition for the output of getting preferences.","type":"text"}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/init(from:)"]},{"identifiers":["doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/preference"],"title":"Instance Properties"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/atprotokit\/actorgetpreferencesoutput"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput"},"sections":[],"kind":"symbol","relationshipsSections":[{"identifiers":["doc:\/\/ATProtoKit\/Se","doc:\/\/ATProtoKit\/SE"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"ActorGetPreferencesOutput","kind":"identifier"}]}]},{"kind":"content","content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"name":"Note","style":"note","type":"aside","content":[{"inlineContent":[{"text":"According to the AT Protocol specifications: “Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import\/export during","type":"text"},{"type":"text","text":" "},{"text":"account migration. Requires auth.”","type":"text"}],"type":"paragraph"}]},{"name":"See Also","type":"aside","content":[{"inlineContent":[{"text":"This is based on the ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/bluesky-social\/atproto\/blob\/main\/lexicons\/app\/bsky\/actor\/getPreferences.json"},{"type":"text","text":" lexicon."}],"type":"paragraph"}],"style":"note"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/ATProtoKit\/documentation\/ATProtoKit"]]},"metadata":{"modules":[{"name":"ATProtoKit"}],"roleHeading":"Structure","symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ActorGetPreferencesOutput","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"ActorGetPreferencesOutput"}],"role":"symbol","title":"ActorGetPreferencesOutput","externalID":"s:10ATProtoKit25ActorGetPreferencesOutputV"},"references":{"doc://ATProtoKit/documentation/ATProtoKit":{"type":"topic","identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit","title":"ATProtoKit","abstract":[],"role":"collection","kind":"symbol","url":"\/documentation\/atprotokit"},"doc://ATProtoKit/documentation/ATProtoKit/ActorGetPreferencesOutput/preference":{"title":"preference","identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/preference","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"preference"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10ATProtoKit16ActorPreferencesV","text":"ActorPreferences","kind":"typeIdentifier"}],"role":"symbol","type":"topic","abstract":[{"text":"The list of preferences in the user’s account.","type":"text"}],"url":"\/documentation\/atprotokit\/actorgetpreferencesoutput\/preference"},"doc://ATProtoKit/documentation/ATProtoKit/ActorGetPreferencesOutput":{"identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput","role":"symbol","title":"ActorGetPreferencesOutput","type":"topic","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ActorGetPreferencesOutput","kind":"identifier"}],"abstract":[{"type":"text","text":"A data model definition for the output of getting preferences."}],"navigatorTitle":[{"text":"ActorGetPreferencesOutput","kind":"identifier"}],"url":"\/documentation\/atprotokit\/actorgetpreferencesoutput"},"https://github.com/bluesky-social/atproto/blob/main/lexicons/app/bsky/actor/getPreferences.json":{"identifier":"https:\/\/github.com\/bluesky-social\/atproto\/blob\/main\/lexicons\/app\/bsky\/actor\/getPreferences.json","url":"https:\/\/github.com\/bluesky-social\/atproto\/blob\/main\/lexicons\/app\/bsky\/actor\/getPreferences.json","titleInlineContent":[{"code":"app.bsky.actor.getPreferences","type":"codeVoice"}],"title":"app.bsky.actor.getPreferences","type":"link"},"doc://ATProtoKit/Se":{"identifier":"doc:\/\/ATProtoKit\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://ATProtoKit/SE":{"identifier":"doc:\/\/ATProtoKit\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://ATProtoKit/documentation/ATProtoKit/ActorGetPreferencesOutput/init(from:)":{"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/init(from:)","type":"topic","title":"init(from:)","kind":"symbol","url":"\/documentation\/atprotokit\/actorgetpreferencesoutput\/init(from:)","abstract":[]}}}

docs/data/documentation/atprotokit/actorgetpreferencesoutput/init(from:).json

@@ -0,0 +1 @@
+{"metadata":{"modules":[{"name":"ATProtoKit"}],"symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"externalID":"s:10ATProtoKit25ActorGetPreferencesOutputV4fromACs7Decoder_p_tKcfc","title":"init(from:)","role":"symbol","roleHeading":"Initializer"},"identifier":{"url":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/init(from:)","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Decodable.init(from:)"},{"text":".","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/atprotokit\/actorgetpreferencesoutput\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/ATProtoKit\/documentation\/ATProtoKit","doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput"]]},"references":{"doc://ATProtoKit/documentation/ATProtoKit/ActorGetPreferencesOutput":{"identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput","role":"symbol","title":"ActorGetPreferencesOutput","type":"topic","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ActorGetPreferencesOutput","kind":"identifier"}],"abstract":[{"type":"text","text":"A data model definition for the output of getting preferences."}],"navigatorTitle":[{"text":"ActorGetPreferencesOutput","kind":"identifier"}],"url":"\/documentation\/atprotokit\/actorgetpreferencesoutput"},"doc://ATProtoKit/documentation/ATProtoKit":{"type":"topic","identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit","title":"ATProtoKit","abstract":[],"role":"collection","kind":"symbol","url":"\/documentation\/atprotokit"},"doc://ATProtoKit/documentation/ATProtoKit/ActorGetPreferencesOutput/init(from:)":{"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/init(from:)","type":"topic","title":"init(from:)","kind":"symbol","url":"\/documentation\/atprotokit\/actorgetpreferencesoutput\/init(from:)","abstract":[]}}}

docs/data/documentation/atprotokit/actorgetpreferencesoutput/preference.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"preference"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10ATProtoKit16ActorPreferencesV","kind":"typeIdentifier","text":"ActorPreferences","identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorPreferences"}],"platforms":["macOS"],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/preference"},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"ATProtoKit"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"preference","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10ATProtoKit16ActorPreferencesV","text":"ActorPreferences"}],"externalID":"s:10ATProtoKit25ActorGetPreferencesOutputV10preferenceAA0cE0Vvp","title":"preference","role":"symbol","roleHeading":"Instance Property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/ATProtoKit\/documentation\/ATProtoKit","doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput"]]},"sections":[],"abstract":[{"type":"text","text":"The list of preferences in the user’s account."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/atprotokit\/actorgetpreferencesoutput\/preference"]}],"references":{"doc://ATProtoKit/documentation/ATProtoKit/ActorGetPreferencesOutput":{"identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput","role":"symbol","title":"ActorGetPreferencesOutput","type":"topic","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ActorGetPreferencesOutput","kind":"identifier"}],"abstract":[{"type":"text","text":"A data model definition for the output of getting preferences."}],"navigatorTitle":[{"text":"ActorGetPreferencesOutput","kind":"identifier"}],"url":"\/documentation\/atprotokit\/actorgetpreferencesoutput"},"doc://ATProtoKit/documentation/ATProtoKit/ActorGetPreferencesOutput/preference":{"title":"preference","identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorGetPreferencesOutput\/preference","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"preference"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10ATProtoKit16ActorPreferencesV","text":"ActorPreferences","kind":"typeIdentifier"}],"role":"symbol","type":"topic","abstract":[{"text":"The list of preferences in the user’s account.","type":"text"}],"url":"\/documentation\/atprotokit\/actorgetpreferencesoutput\/preference"},"doc://ATProtoKit/documentation/ATProtoKit":{"type":"topic","identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit","title":"ATProtoKit","abstract":[],"role":"collection","kind":"symbol","url":"\/documentation\/atprotokit"},"doc://ATProtoKit/documentation/ATProtoKit/ActorPreferences":{"title":"ActorPreferences","kind":"symbol","identifier":"doc:\/\/ATProtoKit\/documentation\/ATProtoKit\/ActorPreferences","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ActorPreferences"}],"role":"symbol","abstract":[{"text":"A data model for a preferences definition.","type":"text"}],"type":"topic","url":"\/documentation\/atprotokit\/actorpreferences","navigatorTitle":[{"text":"ActorPreferences","kind":"identifier"}]}}}