Move docs script to scripts

Author: hmlongco

docs.sh Scripts/docs.shdocs.sh renamed to Scripts/docs.sh

@@ -1,4 +1,5 @@
 swift package \
+    --package-path ../Factory \
     --allow-writing-to-directory ./docs \
     generate-documentation --target FactoryKit \
     --disable-indexing \

docs/data/documentation/factorykit.json

@@ -1 +1 @@
-{"hierarchy":{"paths":[["doc:\/\/FactoryKit\/documentation\/FactoryKit"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering"},"sections":[],"variants":[{"paths":["\/documentation\/factorykit\/autoregistering"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AutoRegistering","kind":"identifier"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"Add this protocol to a container to support first-time registration of needed dependencies prior to first resolution"},{"type":"text","text":" "},{"type":"text","text":"of a dependency on that container."}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["extension Container: @retroactive AutoRegistering {","    func autoRegister() {","        someService.register {","            CrossModuleService()","        }","    }","}"]},{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"autoRegister"},{"text":" function is called on each instantiated container prior to","type":"text"},{"text":" ","type":"text"},{"text":"the first resolution of a Factory on that container.","type":"text"}],"type":"paragraph"},{"style":"warning","type":"aside","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"text":"Calling ","type":"text"},{"code":"container.manager.reset(options: .all)","type":"codeVoice"},{"text":" restores the container to it’s initial state","type":"text"},{"text":" ","type":"text"},{"text":"and autoRegister will be called again if it exists.","type":"text"}]}]},{"inlineContent":[{"text":"The ","type":"text"},{"code":"@retroactive","type":"codeVoice"},{"text":" attribute is needed as of Swift 6 to silence a conformance warning.","type":"text"}],"type":"paragraph"}]}],"metadata":{"title":"AutoRegistering","roleHeading":"Protocol","role":"symbol","navigatorTitle":[{"text":"AutoRegistering","kind":"identifier"}],"modules":[{"name":"FactoryKit"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AutoRegistering"}],"externalID":"s:10FactoryKit15AutoRegisteringP","symbolKind":"protocol"},"topicSections":[{"anchor":"Instance-Methods","title":"Instance Methods","identifiers":["doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()"],"generated":true}],"kind":"symbol","abstract":[{"text":"Adds an registration “hook” to a ","type":"text"},{"type":"codeVoice","code":"Container"},{"text":".","type":"text"}],"references":{"doc://FactoryKit/documentation/FactoryKit/AutoRegistering/autoRegister()":{"title":"autoRegister()","identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()","url":"\/documentation\/factorykit\/autoregistering\/autoregister()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"autoRegister","kind":"identifier"},{"text":"()","kind":"text"}],"kind":"symbol","type":"topic","required":true,"abstract":[{"text":"User provided function that supports first-time registration of needed dependencies prior to first resolution","type":"text"},{"text":" ","type":"text"},{"text":"of a dependency on that container.","type":"text"}]},"doc://FactoryKit/documentation/FactoryKit/AutoRegistering":{"abstract":[{"type":"text","text":"Adds an registration “hook” to a "},{"type":"codeVoice","code":"Container"},{"type":"text","text":"."}],"type":"topic","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"AutoRegistering","kind":"identifier"}],"identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AutoRegistering","kind":"identifier"}],"title":"AutoRegistering","url":"\/documentation\/factorykit\/autoregistering"},"doc://FactoryKit/documentation/FactoryKit":{"abstract":[{"text":"A modern approach to Container-Based Dependency Injection for Swift and SwiftUI.","type":"text"}],"url":"\/documentation\/factorykit","type":"topic","title":"FactoryKit","identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit","kind":"symbol","role":"collection"}}}
+{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/FactoryKit\/documentation\/FactoryKit"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering"},"abstract":[{"text":"Adds an registration “hook” to a ","type":"text"},{"code":"Container","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AutoRegistering"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Overview","level":2,"anchor":"overview"},{"inlineContent":[{"type":"text","text":"Add this protocol to a container to support first-time registration of needed dependencies prior to first resolution"},{"type":"text","text":" "},{"type":"text","text":"of a dependency on that container."}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["extension Container: @retroactive AutoRegistering {","    func autoRegister() {","        someService.register {","            CrossModuleService()","        }","    }","}"]},{"inlineContent":[{"type":"text","text":"The "},{"code":"autoRegister","type":"codeVoice"},{"type":"text","text":" function is called on each instantiated container prior to"},{"type":"text","text":" "},{"type":"text","text":"the first resolution of a Factory on that container."}],"type":"paragraph"},{"name":"Warning","style":"warning","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Calling "},{"code":"container.manager.reset(options: .all)","type":"codeVoice"},{"type":"text","text":" restores the container to it’s initial state"},{"type":"text","text":" "},{"type":"text","text":"and autoRegister will be called again if it exists."}]}]},{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"@retroactive"},{"type":"text","text":" attribute is needed as of Swift 6 to silence a conformance warning."}],"type":"paragraph"}],"kind":"content"}],"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AutoRegistering","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"AutoRegistering","kind":"identifier"}],"symbolKind":"protocol","roleHeading":"Protocol","modules":[{"name":"FactoryKit"}],"externalID":"s:10FactoryKit15AutoRegisteringP","title":"AutoRegistering"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/factorykit\/autoregistering"]}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()"],"generated":true,"anchor":"Instance-Methods"}],"references":{"doc://FactoryKit/documentation/FactoryKit/AutoRegistering":{"abstract":[{"type":"text","text":"Adds an registration “hook” to a "},{"type":"codeVoice","code":"Container"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","title":"AutoRegistering","url":"\/documentation\/factorykit\/autoregistering","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AutoRegistering"}],"navigatorTitle":[{"kind":"identifier","text":"AutoRegistering"}],"identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering","type":"topic"},"doc://FactoryKit/documentation/FactoryKit":{"abstract":[{"type":"text","text":"A modern approach to Container-Based Dependency Injection for Swift and SwiftUI."}],"title":"FactoryKit","type":"topic","kind":"symbol","identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit","url":"\/documentation\/factorykit","role":"collection"},"doc://FactoryKit/documentation/FactoryKit/AutoRegistering/autoRegister()":{"identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"autoRegister"},{"kind":"text","text":"()"}],"abstract":[{"type":"text","text":"User provided function that supports first-time registration of needed dependencies prior to first resolution"},{"type":"text","text":" "},{"text":"of a dependency on that container.","type":"text"}],"title":"autoRegister()","type":"topic","url":"\/documentation\/factorykit\/autoregistering\/autoregister()","required":true}}}

docs/data/documentation/factorykit/autoregistering.json

@@ -1 +1 @@
-{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/FactoryKit\/documentation\/FactoryKit","doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering"]]},"metadata":{"role":"symbol","externalID":"s:10FactoryKit15AutoRegisteringP12autoRegisteryyF","symbolKind":"method","modules":[{"name":"FactoryKit"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"autoRegister"},{"kind":"text","text":"()"}],"title":"autoRegister()","required":true,"roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"autoRegister"},{"kind":"text","text":"()"}]}]}],"sections":[],"abstract":[{"type":"text","text":"User provided function that supports first-time registration of needed dependencies prior to first resolution"},{"type":"text","text":" "},{"type":"text","text":"of a dependency on that container."}],"variants":[{"paths":["\/documentation\/factorykit\/autoregistering\/autoregister()"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://FactoryKit/documentation/FactoryKit/AutoRegistering":{"abstract":[{"type":"text","text":"Adds an registration “hook” to a "},{"type":"codeVoice","code":"Container"},{"type":"text","text":"."}],"type":"topic","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"AutoRegistering","kind":"identifier"}],"identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AutoRegistering","kind":"identifier"}],"title":"AutoRegistering","url":"\/documentation\/factorykit\/autoregistering"},"doc://FactoryKit/documentation/FactoryKit/AutoRegistering/autoRegister()":{"title":"autoRegister()","identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()","url":"\/documentation\/factorykit\/autoregistering\/autoregister()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"autoRegister","kind":"identifier"},{"text":"()","kind":"text"}],"kind":"symbol","type":"topic","required":true,"abstract":[{"text":"User provided function that supports first-time registration of needed dependencies prior to first resolution","type":"text"},{"text":" ","type":"text"},{"text":"of a dependency on that container.","type":"text"}]},"doc://FactoryKit/documentation/FactoryKit":{"abstract":[{"text":"A modern approach to Container-Based Dependency Injection for Swift and SwiftUI.","type":"text"}],"url":"\/documentation\/factorykit","type":"topic","title":"FactoryKit","identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit","kind":"symbol","role":"collection"}}}
+{"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"autoRegister"},{"kind":"text","text":"()"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()"},"metadata":{"symbolKind":"method","externalID":"s:10FactoryKit15AutoRegisteringP12autoRegisteryyF","title":"autoRegister()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"autoRegister"},{"kind":"text","text":"()"}],"required":true,"roleHeading":"Instance Method","modules":[{"name":"FactoryKit"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/FactoryKit\/documentation\/FactoryKit","doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering"]]},"abstract":[{"text":"User provided function that supports first-time registration of needed dependencies prior to first resolution","type":"text"},{"text":" ","type":"text"},{"text":"of a dependency on that container.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/factorykit\/autoregistering\/autoregister()"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://FactoryKit/documentation/FactoryKit":{"abstract":[{"type":"text","text":"A modern approach to Container-Based Dependency Injection for Swift and SwiftUI."}],"title":"FactoryKit","type":"topic","kind":"symbol","identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit","url":"\/documentation\/factorykit","role":"collection"},"doc://FactoryKit/documentation/FactoryKit/AutoRegistering/autoRegister()":{"identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering\/autoRegister()","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"autoRegister"},{"kind":"text","text":"()"}],"abstract":[{"type":"text","text":"User provided function that supports first-time registration of needed dependencies prior to first resolution"},{"type":"text","text":" "},{"text":"of a dependency on that container.","type":"text"}],"title":"autoRegister()","type":"topic","url":"\/documentation\/factorykit\/autoregistering\/autoregister()","required":true},"doc://FactoryKit/documentation/FactoryKit/AutoRegistering":{"abstract":[{"type":"text","text":"Adds an registration “hook” to a "},{"type":"codeVoice","code":"Container"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","title":"AutoRegistering","url":"\/documentation\/factorykit\/autoregistering","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AutoRegistering"}],"navigatorTitle":[{"kind":"identifier","text":"AutoRegistering"}],"identifier":"doc:\/\/FactoryKit\/documentation\/FactoryKit\/AutoRegistering","type":"topic"}}}