Javier Cicchelli a51fab18ba [Setup] DocC (#13)
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
2023-04-24 15:07:21 +00:00

1 line
5.8 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"`switch`"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","preciseIdentifier":"s:13AmiiboService0A0V","text":"Amiibo"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","preciseIdentifier":"s:13AmiiboService0A0V4GameV","text":"Game"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiibo\/games-swift.struct\/switch"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct\/switch","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"\/\/\/ A list of "},{"type":"reference","isActive":true,"identifier":"https:\/\/en.wikipedia.org\/wiki\/Nintendo_Switch"},{"type":"text","text":" games the amiibo can be used with."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"`switch`"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Game","preciseIdentifier":"s:13AmiiboService0A0V4GameV"},{"kind":"text","text":"]"}],"title":"switch","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:13AmiiboService0A0V5GamesV6switchSayAC4GameVGvp","modules":[{"name":"AmiiboService"}]},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/Amiibo/Games-swift.struct/switch":{"role":"symbol","title":"switch","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"`switch`"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Game","preciseIdentifier":"s:13AmiiboService0A0V4GameV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"\/\/\/ A list of "},{"type":"reference","isActive":true,"identifier":"https:\/\/en.wikipedia.org\/wiki\/Nintendo_Switch"},{"type":"text","text":" games the amiibo can be used with."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct\/switch","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/games-swift.struct\/switch"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"},"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"},"https://en.wikipedia.org/wiki/Nintendo_Switch":{"title":"Nintendo Switch system","titleInlineContent":[{"type":"text","text":"Nintendo Switch system"}],"type":"link","identifier":"https:\/\/en.wikipedia.org\/wiki\/Nintendo_Switch","url":"https:\/\/en.wikipedia.org\/wiki\/Nintendo_Switch"},"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"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Games-swift.struct":{"role":"symbol","title":"Amiibo.Games","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Games"}],"abstract":[{"type":"text","text":"This model represents the list of games related to a particular amiibo, grouped by system."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Games"}],"url":"\/documentation\/amiiboservice\/amiibo\/games-swift.struct"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Game":{"role":"symbol","title":"Amiibo.Game","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Game"}],"abstract":[{"type":"text","text":"This model structs represents a game that is related to an amiibo, when requested to the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Game"}],"url":"\/documentation\/amiiboservice\/amiibo\/game"},"https://www.amiiboapi.com/docs/#showGames":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames","url":"https:\/\/www.amiiboapi.com\/docs\/#showGames"}}}