Skip to content

Commit

Permalink
Add latest documentation for SoulverCore 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
zcohan committed Nov 26, 2024
1 parent ad78430 commit 1f5c551
Show file tree
Hide file tree
Showing 5,077 changed files with 5,455 additions and 2 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# SoulverCore-Documentation
DocC Swift documentation for the SoulverCore framework
## SoulverCore Documentation

You can browse the complete documentation for SoulverCore [here](https://soulverteam.github.io/SoulverCore-Documentation/documentation/soulvercore).

Alternatively, a [DocC archive](https://developer.apple.com/documentation/docc) compatibile with Xcode or [Dash](https://kapeli.com/dash) is also available for [download](https://github.com/SoulverTeam/SoulverCore/releases/latest/download/SoulverCore.doccarchive.zip).
9 changes: 9 additions & 0 deletions docs/css/866.60f074fd.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/989.4f123103.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.91c07ba9.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/index.3a335429.css

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/data/documentation/soulvercore/airport.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"metadata":{"navigatorTitle":[{"text":"Airport","kind":"identifier"}],"role":"symbol","title":"Airport","roleHeading":"Structure","modules":[{"name":"SoulverCore"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Airport","kind":"identifier"}],"symbolKind":"struct","externalID":"s:11SoulverCore7AirportV"},"identifier":{"url":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/soulvercore\/airport"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Airport","kind":"identifier"}],"languages":["swift"]}]}],"seeAlsoSections":[{"title":"Places (timezones)","anchor":"Places-timezones","generated":true,"identifiers":["doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Place","doc:\/\/app.soulver.core\/documentation\/SoulverCore\/City","doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Country"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/app.soulver.core\/documentation\/SoulverCore"]]},"sections":[],"abstract":[{"text":"Represents an airport on planet earth","type":"text"}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/app.soulver.core\/s8CopyableP","doc:\/\/app.soulver.core\/Se","doc:\/\/app.soulver.core\/SE","doc:\/\/app.soulver.core\/SQ","doc:\/\/app.soulver.core\/SH"],"type":"conformsTo","title":"Conforms To"}],"kind":"symbol","topicSections":[{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/iata_code","doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/name"],"title":"Instance Properties"},{"identifiers":["doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/Decodable-Implementations","doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/Equatable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"references":{"doc://app.soulver.core/documentation/SoulverCore/Airport":{"type":"topic","url":"\/documentation\/soulvercore\/airport","navigatorTitle":[{"text":"Airport","kind":"identifier"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Airport"}],"title":"Airport","abstract":[{"text":"Represents an airport on planet earth","type":"text"}],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport"},"doc://app.soulver.core/SE":{"title":"Swift.Encodable","identifier":"doc:\/\/app.soulver.core\/SE","type":"unresolvable"},"doc://app.soulver.core/documentation/SoulverCore/Airport/Decodable-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/soulvercore\/airport\/decodable-implementations","title":"Decodable Implementations","role":"collectionGroup","identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/Decodable-Implementations","abstract":[]},"doc://app.soulver.core/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/app.soulver.core\/SQ","type":"unresolvable"},"doc://app.soulver.core/documentation/SoulverCore/Country":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Country","kind":"identifier"}],"abstract":[{"text":"Represents a country on planet earth","type":"text"}],"kind":"symbol","url":"\/documentation\/soulvercore\/country","title":"Country","identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Country","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Country"}]},"doc://app.soulver.core/documentation/SoulverCore/Place":{"type":"topic","identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Place","kind":"symbol","abstract":[{"type":"text","text":"An object representing a place that can be used as a timezone"},{"type":"text","text":" "},{"text":"To support custom places in your expressions, set the “customPlaces” property on the EngineCustomization","type":"text"}],"title":"Place","url":"\/documentation\/soulvercore\/place","navigatorTitle":[{"kind":"identifier","text":"Place"}],"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Place"}]},"doc://app.soulver.core/documentation/SoulverCore/Airport/name":{"kind":"symbol","type":"topic","url":"\/documentation\/soulvercore\/airport\/name","title":"name","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/name","abstract":[{"text":"The name of the airport (like “San Francisco International”)","type":"text"}]},"doc://app.soulver.core/documentation/SoulverCore":{"title":"SoulverCore","identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore","role":"collection","abstract":[{"text":"A powerful natural language calculation engine","type":"text"}],"type":"topic","url":"\/documentation\/soulvercore","kind":"symbol"},"doc://app.soulver.core/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/app.soulver.core\/s8CopyableP","type":"unresolvable"},"doc://app.soulver.core/documentation/SoulverCore/Airport/Equatable-Implementations":{"url":"\/documentation\/soulvercore\/airport\/equatable-implementations","abstract":[],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/Equatable-Implementations","kind":"article","title":"Equatable Implementations","role":"collectionGroup","type":"topic"},"doc://app.soulver.core/documentation/SoulverCore/Airport/iata_code":{"kind":"symbol","type":"topic","url":"\/documentation\/soulvercore\/airport\/iata_code","title":"iata_code","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"iata_code"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/iata_code","abstract":[{"text":"The standard IATA code for this airport","type":"text"}]},"doc://app.soulver.core/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/app.soulver.core\/SH","type":"unresolvable"},"doc://app.soulver.core/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/app.soulver.core\/Se","type":"unresolvable"},"doc://app.soulver.core/documentation/SoulverCore/City":{"kind":"symbol","abstract":[{"type":"text","text":"Represents a city on planet earth"}],"navigatorTitle":[{"text":"City","kind":"identifier"}],"title":"City","role":"symbol","url":"\/documentation\/soulvercore\/city","identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/City","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"City","kind":"identifier"}],"type":"topic"}}}
1 change: 1 addition & 0 deletions docs/data/documentation/soulvercore/airport/!=(_:_:).json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:11SoulverCore7AirportV","modules":[{"relatedModules":["Swift"],"name":"SoulverCore"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"extendedModule":"Swift","title":"!=(_:_:)","roleHeading":"Operator","role":"symbol","symbolKind":"op"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/app.soulver.core\/documentation\/SoulverCore","doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport","doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/Equatable-Implementations"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/!=(_:_:)"},"variants":[{"paths":["\/documentation\/soulvercore\/airport\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://app.soulver.core/documentation/SoulverCore/Airport/!=(_:_:)":{"url":"\/documentation\/soulvercore\/airport\/!=(_:_:)","abstract":[],"role":"symbol","kind":"symbol","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/!=(_:_:)","title":"!=(_:_:)"},"doc://app.soulver.core/documentation/SoulverCore/Airport":{"type":"topic","url":"\/documentation\/soulvercore\/airport","navigatorTitle":[{"text":"Airport","kind":"identifier"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Airport"}],"title":"Airport","abstract":[{"text":"Represents an airport on planet earth","type":"text"}],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport"},"doc://app.soulver.core/documentation/SoulverCore":{"title":"SoulverCore","identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore","role":"collection","abstract":[{"text":"A powerful natural language calculation engine","type":"text"}],"type":"topic","url":"\/documentation\/soulvercore","kind":"symbol"},"doc://app.soulver.core/documentation/SoulverCore/Airport/Equatable-Implementations":{"url":"\/documentation\/soulvercore\/airport\/equatable-implementations","abstract":[],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/Equatable-Implementations","kind":"article","title":"Equatable Implementations","role":"collectionGroup","type":"topic"}}}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"sections":[],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/init(from:)"],"generated":true,"anchor":"Initializers"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/soulvercore\/airport\/decodable-implementations"]}],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/Decodable-Implementations"},"metadata":{"roleHeading":"API Collection","title":"Decodable Implementations","modules":[{"name":"SoulverCore"}],"role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/app.soulver.core\/documentation\/SoulverCore","doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport"]]},"references":{"doc://app.soulver.core/documentation/SoulverCore/Airport/init(from:)":{"role":"symbol","abstract":[],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport\/init(from:)","url":"\/documentation\/soulvercore\/airport\/init(from:)","kind":"symbol","type":"topic","title":"init(from:)"},"doc://app.soulver.core/documentation/SoulverCore":{"title":"SoulverCore","identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore","role":"collection","abstract":[{"text":"A powerful natural language calculation engine","type":"text"}],"type":"topic","url":"\/documentation\/soulvercore","kind":"symbol"},"doc://app.soulver.core/documentation/SoulverCore/Airport":{"type":"topic","url":"\/documentation\/soulvercore\/airport","navigatorTitle":[{"text":"Airport","kind":"identifier"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Airport"}],"title":"Airport","abstract":[{"text":"Represents an airport on planet earth","type":"text"}],"identifier":"doc:\/\/app.soulver.core\/documentation\/SoulverCore\/Airport"}}}
Loading

0 comments on commit 1f5c551

Please sign in to comment.