From bb6bcc275dfe1fafa448d12ada7fd085a4609daf Mon Sep 17 00:00:00 2001
From: Danilo Joksimovic <djoksimo@uwaterloo.ca>
Date: Sun, 10 Sep 2023 14:34:33 -0400
Subject: [PATCH] Add ability to generate reference documentation

---
 .gitignore  |  3 +++
 .jazzy.yaml | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 .jazzy.yaml

diff --git a/.gitignore b/.gitignore
index 3df24aa4..b767e674 100644
--- a/.gitignore
+++ b/.gitignore
@@ -61,3 +61,6 @@ cobertura.xml
 
 # macOS
 .DS_Store
+
+# jazzy-generated reference documentation
+reference-docs/
\ No newline at end of file
diff --git a/.jazzy.yaml b/.jazzy.yaml
new file mode 100644
index 00000000..feee99c1
--- /dev/null
+++ b/.jazzy.yaml
@@ -0,0 +1,51 @@
+# The name of your project
+module: ForageSDK
+
+# whether to clean the build folder before generating docs, ensuring that you're starting fresh.
+clean: true
+
+swift_build_tool: xcodebuild
+
+# xcodebuild command arguments
+build_tool_arguments:
+  - "-scheme"
+  - "ForageSDK"
+  - "-sdk"
+  - "iphoneos"
+  - "-destination"
+  - "name=iPhone 8"
+
+# The path to the directory containing your source code
+# source_directory: Sources/
+
+# The path to the directory where Jazzy should output the documentation
+output: reference-docs/
+
+exclude:
+  - /*Vendor
+  - Sources/ForageSDK/Vendor/*
+
+# The list of files to include in the documentation
+# source:
+#   - MyProject/SourceFile1.swift
+#   - MyProject/SourceFile2.swift
+
+# The theme to use for the documentation
+theme: fullwidth
+
+# The author of the project
+author: Forage
+
+# The version of the project
+module_version: 4.0.0
+
+# Default text for undocumented symbols.
+undocumented_text: ""
+
+# The description of the project
+abstract: Forage SDK is an iOS library for processing EBT payments. You can use the library to add all of the essential EBT checkout operations to you iOS app.
+
+# The list of GitHub repositories to link to in the documentation
+github_file_prefix: https://github.com/teamforage/forage-ios-sdk/blob/master/
+
+hide_documentation_coverage: true