Javier Cicchelli
a51fab18ba
This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project. To provide further details about the work done: - [x] created the documentation catalog for the project in Xcode; - [x] added the `Swift-DocC-Plugin` dependency to the `Package` file; - [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file; - [x] generated documentation for Xcode and Github pages; - [x] added the package logo assets to the project; - [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes; - [x] added the `.env` file to the `.gitignore` file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: #13
1 line
4.8 KiB
JSON
1 line
4.8 KiB
JSON
{"variants":[{"paths":["\/documentation\/amiiboservice\/keyname\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName\/Decodable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName\/init(from:)"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"AmiiboService"}],"role":"collectionGroup","title":"Decodable Implementations"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/KeyName/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName\/init(from:)","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/keyname\/init(from:)"},"doc://AmiiboService/documentation/AmiiboService/KeyName":{"role":"symbol","title":"KeyName","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeyName"}],"abstract":[{"type":"text","text":"This model is a concrete genetic definition that represents the following models: "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Character"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeyName"}],"url":"\/documentation\/amiiboservice\/keyname"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/Character":{"role":"symbol","title":"Character","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Character"}],"abstract":[{"type":"text","text":"This model represents the character an amiibo is associated to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Character","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Character"}],"url":"\/documentation\/amiiboservice\/character"},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"role":"symbol","title":"AmiiboType","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboType"}],"abstract":[{"type":"text","text":"This model represents the type an amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}],"url":"\/documentation\/amiiboservice\/amiibotype"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeries":{"role":"symbol","title":"AmiiboSeries","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeries"}],"abstract":[{"type":"text","text":"This model represents the series an amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"url":"\/documentation\/amiiboservice\/amiiboseries"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"role":"symbol","title":"GameSeries","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameSeries"}],"abstract":[{"type":"text","text":"This model represents the games series an amiibo is associated to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameSeries"}],"url":"\/documentation\/amiiboservice\/gameseries"}}} |