docs: added jazzy documentation setup with GitHub pages (#7)

.github/workflows/documentation.yml

@@ -0,0 +1,45 @@
+name: Documentation
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy_docs:
+    name: Deploy Documentation
+    runs-on: macos-12
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Generate Documentation
+        run: |
+          sed  -i.bak "s/title:\(.*\)/title:\1 (${{ github.ref }})/g" .jazzy.yaml
+          bundle exec jazzy
+
+      - name: Fix Invalid URLs
+        run: |
+          cd docs
+          touch .nojekyll
+
+      - name: Commit files
+        run: |
+          cd docs
+          git init
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add .
+          git commit -m "Deploying Updated Jazzy Docs"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          directory: docs
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          force: true

.gitignore

@@ -14,3 +14,6 @@ coverage
 
 # Log files
 *.log
+
+# Ruby
+/vendor

.jazzy.yaml

@@ -0,0 +1,45 @@
+# Name of module being documented.
+module: OnLaunch_iOS_Client
+# Folder to output the HTML docs to
+output: docs
+
+# Name of author to attribute in docs
+author: kula app GmbH
+# Author URL of this project
+author_url: https://kula.app
+# Copyright markdown rendered at the bottom of the docs pages
+copyright: "© 2023 [kula app GmbH](https://kula.app). All rights reserved."
+# URL to link from the source host's logo.
+source_host_url: https://github.com/kula-app/OnLaunch-iOS-Client
+
+# Which theme to use. Specify either 'apple' (default), one of the other built-in theme names, or the
+# path to your mustache templates and other assets for a custom theme.
+theme: fullwidth
+# Title to display at the top of each page, overriding the default generated from module name and version.
+title: OnLaunch iOS Client
+
+# The SDK for which your code should be built.
+sdk: iphone
+# Source file pathnames to be included in documentation. Supports wildcards.
+include: Sources/OnLaunch-iOS-Client/**
+
+# Control whether Jazzy uses Swift Package Manager, xcodebuild, or swift-symbolgraph to build the module to be documented.
+# By default it uses xcodebuild if there is a .xcodeproj file in the source directory.
+swift_build_tool: spm
+# Arguments to forward to xcodebuild, swift build, or sourcekitten.
+build_tool_arguments: []
+# The base URL on the source host of the project's files, to link from individual declarations.
+# For example https://github.com/realm/realm-cocoa/tree/v0.87.1
+# source_host_files_url: ''
+# minimum access control level to document
+min_acl: public
+# Don't document declarations that have no documentation comments.
+skip_undocumented: false
+# Default text for undocumented symbols. The default is "Undocumented", put "" if no text is required
+undocumented_text: Undocumented
+# Replace unsafe characters in filenames with an encoded representation.
+# This will reduce human readability of some URLs, but may be necessary for projects that
+# expose filename-unfriendly functions such as /(_:_:)
+use_safe_filenames: true
+# Create separate pages for all global declarations (classes, structures, enums etc.) even if they don't have children.
+separate_global_declarations: true

.ruby-version

@@ -0,0 +1 @@
+3.2.0

Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jazzy"

Gemfile.lock

@@ -0,0 +1,119 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (3.0.5)
+      rexml
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    algoliasearch (1.27.5)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
+    atomos (0.1.3)
+    claide (1.1.0)
+    cocoapods (1.11.3)
+      addressable (~> 2.8)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.11.3)
+      cocoapods-deintegrate (>= 1.0.3, < 2.0)
+      cocoapods-downloader (>= 1.4.0, < 2.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.4.0, < 2.0)
+      cocoapods-try (>= 1.1.0, < 2.0)
+      colored2 (~> 3.1)
+      escape (~> 0.0.4)
+      fourflusher (>= 2.3.0, < 3.0)
+      gh_inspector (~> 1.0)
+      molinillo (~> 0.8.0)
+      nap (~> 1.0)
+      ruby-macho (>= 1.0, < 3.0)
+      xcodeproj (>= 1.21.0, < 2.0)
+    cocoapods-core (1.11.3)
+      activesupport (>= 5.0, < 7)
+      addressable (~> 2.8)
+      algoliasearch (~> 1.0)
+      concurrent-ruby (~> 1.1)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+      netrc (~> 0.11)
+      public_suffix (~> 4.0)
+      typhoeus (~> 1.0)
+    cocoapods-deintegrate (1.0.5)
+    cocoapods-downloader (1.6.3)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.1)
+    cocoapods-trunk (1.6.0)
+      nap (>= 0.8, < 2.0)
+      netrc (~> 0.11)
+    cocoapods-try (1.2.0)
+    colored2 (3.1.2)
+    concurrent-ruby (1.1.10)
+    escape (0.0.4)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    fourflusher (2.3.1)
+    fuzzy_match (2.0.4)
+    gh_inspector (1.1.3)
+    httpclient (2.8.3)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jazzy (0.14.3)
+      cocoapods (~> 1.5)
+      mustache (~> 1.1)
+      open4 (~> 1.3)
+      redcarpet (~> 3.4)
+      rexml (~> 3.2)
+      rouge (>= 2.0.6, < 4.0)
+      sassc (~> 2.1)
+      sqlite3 (~> 1.3)
+      xcinvoke (~> 0.3.0)
+    json (2.6.3)
+    liferaft (0.0.6)
+    mini_portile2 (2.8.1)
+    minitest (5.17.0)
+    molinillo (0.8.0)
+    mustache (1.1.1)
+    nanaimo (0.3.0)
+    nap (1.1.0)
+    netrc (0.11.0)
+    open4 (1.3.4)
+    public_suffix (4.0.7)
+    redcarpet (3.5.1)
+    rexml (3.2.5)
+    rouge (3.30.0)
+    ruby-macho (2.5.1)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sqlite3 (1.5.4)
+      mini_portile2 (~> 2.8.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    xcinvoke (0.3.0)
+      liferaft (~> 0.0.6)
+    xcodeproj (1.22.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.3.0)
+      rexml (~> 3.2.4)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  jazzy
+
+BUNDLED WITH
+   2.4.3