.jazzy.yaml

module: Siesta
author: Bust Out Solutions
author_url: http://bustoutsolutions.com
github_url: https://github.com/bustoutsolutions/siesta
exclude:
  - "**/*-ObjC.swift"
  - "**/*Deprecations.swift"
  - "Source/Siesta/Support/Siesta-ObjC.swift"     # until Cocoadocs gets https://github.com/realm/jazzy/pull/640
  - "Source/SiestaUI/SiestaUI-ObjC.swift"         # ditto
  - "Source/Siesta/Support/Ω_Deprecations.swift"  # ditto

copyright: '© 2020 [Bust Out Solutions](http://bustoutsolutions.com) under [open source license](https://github.com/bustoutsolutions/siesta/blob/master/LICENSE).'

swift_version: 5.3.1

theme: fullwidth

custom_categories:
  - name: Resources
    children:
    - Service
    - Resource
    - Entity
    - Configuration
    - ConfigurationPatternConvertible
    - TypedContentAccessors

  - name: Observing Resources
    children:
    - ResourceObserver
    - ResourceObserverClosure
    - ResourceEvent

  - name: Requests
    children:
    - Request
    - RequestMethod
    - RequestState
    - RequestError
    - Response
    - ResponseInfo

  - name: Request Customization
    children:
    - RequestChainAction
    - RequestDelegate
    - RequestCompletionHandler

  - name: Response Pipeline
    children:
    - Pipeline
    - PipelineStage
    - PipelineStageKey
    - ResponseTransformer
    - ResponseContentTransformer
    - StandardTransformer
    - JSONResponseTransformer(_:)
    - TextResponseTransformer(_:)
    - ImageResponseTransformer(_:)

  - name: Logging
    children:
    - SiestaLog

  - name: Caching
    children:
    - EntityCache

  - name: UI Helpers
    children:
    - ResourceStatusOverlay
    - RemoteImageView

  - name: Network Layer
    children:
    - NetworkingProvider
    - NetworkingProviderConvertible
    - RequestNetworking
    - RequestNetworkingCompletionCallback
    - RequestTransferMetrics
    - URLSessionProvider
    - SessionTaskContainer
    - AlamofireProvider