Skip to content

Commit

Permalink
[Improvement] Github Pages documentation (#24)
Browse files Browse the repository at this point in the history 
This PR contains the work done to fix the Github Pages generated documentation, as the assigned base path and documentation URL were not properly defined.

Reviewed-on: https://repo.rock-n-code.com/rock-n-code/swift-libs/pulls/24
Co-authored-by: Javier Cicchelli <[email protected]>
Co-committed-by: Javier Cicchelli <[email protected]>
  • Loading branch information
@mr-rock
mr-rock authored and Javier Cicchelli committed Aug 13, 2023
1 parent f7235cd commit 18d6863
Show file tree
Hide file tree
Showing 624 changed files with 628 additions and 628 deletions.
2 changes: 1 addition & 1 deletion Documents/SwiftLibsCommunication.doccarchive/data/documentation/swiftlibscommunication.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"variants":[{"paths":["\/documentation\/swiftlibscommunication"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","interfaceLanguage":"swift"},"topicSections":[{"title":"Classes","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol"]},{"title":"Protocols","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint"]},{"title":"Structures","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestUseCase","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLResponse"]},{"title":"Enumerations","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestError"]}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"SwiftLibsCommunication","title":"SwiftLibsCommunication","symbolKind":"module","role":"collection","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[[]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Client":{"role":"symbol","title":"Client","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"abstract":[{"type":"text","text":"This protocol defines a client that will be making the remote calls."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/swiftlibscommunication\/client"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MakeURLRequestError":{"role":"symbol","title":"MakeURLRequestError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"MakeURLRequestError"}],"abstract":[{"type":"text","text":"Errors generated out of the "},{"type":"codeVoice","code":"MakeURLRequestUseCase"},{"type":"text","text":" use case."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MakeURLRequestError"}],"url":"\/documentation\/swiftlibscommunication\/makeurlrequesterror"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint":{"role":"symbol","title":"Endpoint","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endpoint"}],"abstract":[{"type":"text","text":"This protocol defines an endpoint to be used in a remote call."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Endpoint"}],"url":"\/documentation\/swiftlibscommunication\/endpoint"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MakeURLRequestUseCase":{"role":"symbol","title":"MakeURLRequestUseCase","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MakeURLRequestUseCase"}],"abstract":[{"type":"text","text":"This use case generate a url request out of a given endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestUseCase","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MakeURLRequestUseCase"}],"url":"\/documentation\/swiftlibscommunication\/makeurlrequestusecase"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLProtocol":{"role":"symbol","title":"MockURLProtocol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLProtocol"}],"abstract":[{"type":"text","text":"This class overrides the "},{"type":"codeVoice","code":"URLProtocol"},{"type":"text","text":" protocol used by the "},{"type":"codeVoice","code":"URLSession"},{"type":"text","text":" to handle the loading of protocol-specific URL data so it is possible to mock URL response for testing purposes."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLProtocol"}],"url":"\/documentation\/swiftlibscommunication\/mockurlprotocol"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPRequestMethod":{"role":"symbol","title":"HTTPRequestMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPRequestMethod"}],"abstract":[{"type":"text","text":"Enumeration that represents the available HTTP request methods to use in this library."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPRequestMethod"}],"url":"\/documentation\/swiftlibscommunication\/httprequestmethod"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLResponse":{"role":"symbol","title":"MockURLResponse","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLResponse"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its response."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLResponse","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLResponse"}],"url":"\/documentation\/swiftlibscommunication\/mockurlresponse"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPResponseCode":{"role":"symbol","title":"HTTPResponseCode","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPResponseCode"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPResponseCode"}],"url":"\/documentation\/swiftlibscommunication\/httpresponsecode"}}}
{"variants":[{"paths":["\/documentation\/swiftlibscommunication"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","interfaceLanguage":"swift"},"topicSections":[{"title":"Classes","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol"]},{"title":"Protocols","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint"]},{"title":"Structures","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestUseCase","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLResponse"]},{"title":"Enumerations","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestError"]}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"SwiftLibsCommunication","title":"SwiftLibsCommunication","symbolKind":"module","role":"collection","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[[]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPRequestMethod":{"role":"symbol","title":"HTTPRequestMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPRequestMethod"}],"abstract":[{"type":"text","text":"Enumeration that represents the available HTTP request methods to use in this library."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPRequestMethod"}],"url":"\/documentation\/swiftlibscommunication\/httprequestmethod"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLResponse":{"role":"symbol","title":"MockURLResponse","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLResponse"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its response."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLResponse","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLResponse"}],"url":"\/documentation\/swiftlibscommunication\/mockurlresponse"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPResponseCode":{"role":"symbol","title":"HTTPResponseCode","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPResponseCode"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPResponseCode"}],"url":"\/documentation\/swiftlibscommunication\/httpresponsecode"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint":{"role":"symbol","title":"Endpoint","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endpoint"}],"abstract":[{"type":"text","text":"This protocol defines an endpoint to be used in a remote call."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Endpoint"}],"url":"\/documentation\/swiftlibscommunication\/endpoint"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Client":{"role":"symbol","title":"Client","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"abstract":[{"type":"text","text":"This protocol defines a client that will be making the remote calls."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/swiftlibscommunication\/client"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MakeURLRequestError":{"role":"symbol","title":"MakeURLRequestError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"MakeURLRequestError"}],"abstract":[{"type":"text","text":"Errors generated out of the "},{"type":"codeVoice","code":"MakeURLRequestUseCase"},{"type":"text","text":" use case."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MakeURLRequestError"}],"url":"\/documentation\/swiftlibscommunication\/makeurlrequesterror"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MakeURLRequestUseCase":{"role":"symbol","title":"MakeURLRequestUseCase","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MakeURLRequestUseCase"}],"abstract":[{"type":"text","text":"This use case generate a url request out of a given endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestUseCase","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MakeURLRequestUseCase"}],"url":"\/documentation\/swiftlibscommunication\/makeurlrequestusecase"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLProtocol":{"role":"symbol","title":"MockURLProtocol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLProtocol"}],"abstract":[{"type":"text","text":"This class overrides the "},{"type":"codeVoice","code":"URLProtocol"},{"type":"text","text":" protocol used by the "},{"type":"codeVoice","code":"URLSession"},{"type":"text","text":" to handle the loading of protocol-specific URL data so it is possible to mock URL response for testing purposes."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLProtocol"}],"url":"\/documentation\/swiftlibscommunication\/mockurlprotocol"}}}
Loading

0 comments on commit 18d6863

Please sign in to comment.