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
2.5 KiB
JSON
1 line
2.5 KiB
JSON
{"variants":[{"paths":["\/documentation\/amiiboservice\/amiibo\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Decodable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/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\/Amiibo"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/Amiibo/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":[{"type":"text","text":"Initialises this model by decoding from the given decoder."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/init(from:)","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/init(from:)"},"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/Amiibo":{"role":"symbol","title":"Amiibo","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"abstract":[{"type":"text","text":"This model struct represents an amiibo that is retrieved from the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"url":"\/documentation\/amiiboservice\/amiibo"},"https://www.amiiboapi.com/docs/#amiibo":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo","url":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"}}} |