IDPROD-2142 part2: generate docs index.html page (#302)

Now generating a `docs/index.html` page that links to the documentation for all of the modules in the repo that have documentation enabled (`Stripe` & `StripeIdentity`). The index page reuses the same html template as the Jazzy theme we use to generate our docs. The descriptions that display for each module are populated by the summary in their podspec file. With the next deploy, this page will be visible at https://stripe.dev/stripe-ios.

Author: mludowise-stripe

.jazzy.yaml

@@ -8,4 +8,4 @@ github_url: https://github.com/stripe/stripe-ios
 github_file_prefix: https://github.com/stripe/stripe-ios/tree/master
 skip_undocumented: true
 hide_documentation_coverage: true
-theme: fullwidth
+theme: .jazzy/theme

.jazzy/theme/templates/doc.mustache

@@ -31,9 +31,16 @@
     {{> header}}
 
     <p class="breadcrumbs">
-      <a class="breadcrumb" href="{{path_to_root}}index.html">{{module_name}} Reference</a>
+      {{#is_root_index}}
+      <a class="breadcrumb" href="{{path_to_root}}index.html">Stripe iOS SDKs</a>
+      {{/is_root_index}}
+      {{^is_root_index}}
+      <a class="breadcrumb" href="{{path_to_root}}../index.html">Stripe iOS SDKs</a>
+      <img class="carat" src="{{path_to_root}}img/carat.png" />
+      <a class="breadcrumb" href="{{path_to_root}}index.html">{{module_name}}</a>
       <img class="carat" src="{{path_to_root}}img/carat.png" />
       {{name}} {{kind}} Reference
+      {{/is_root_index}}
     </p>
 
     <div class="content-wrapper">

.jazzy/theme/templates/header.mustache

@@ -1,6 +1,11 @@
 <header class="header">
   <p class="header-col header-col--primary">
+    {{#is_root_index}}
     <a class="header-link" href="{{path_to_root}}index.html">
+    {{/is_root_index}}
+    {{^is_root_index}}
+    <a class="header-link" href="{{path_to_root}}../index.html">
+    {{/is_root_index}}
       {{docs_title}}
     </a>
     {{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}

.jazzy/theme/templates/index.mustache

@@ -0,0 +1,4 @@
+{{#modules}}
+  <a href="{{path_to_root}}{{directory}}/index.html"><h2 class="heading">{{name}}</h2></a>
+  {{summary}}
+{{/modules}}

Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gem "fastlane"
 gem "cocoapods"
 
-gem "jazzy", "~> 0.13.6"
+gem "jazzy", "~> 0.13.7"
+gem "mustache", "~> 1.1.1"
 
 gem "xcode-install", "~> 2.6"

Gemfile.lock

@@ -188,7 +188,7 @@ GEM
     httpclient (2.8.3)
     i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    jazzy (0.13.6)
+    jazzy (0.13.7)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4
@@ -283,7 +283,8 @@ PLATFORMS
 DEPENDENCIES
   cocoapods
   fastlane
-  jazzy (~> 0.13.6)
+  jazzy (~> 0.13.7)
+  mustache (~> 1.1.1)
   xcode-install (~> 2.6)
 
 BUNDLED WITH

Stripe.podspec

@@ -5,12 +5,12 @@ Pod::Spec.new do |s|
   # Instead, update the VERSION file and run ./ci_scripts/update_version.sh
   s.version                        = '21.7.0'
 
-  s.summary                        = 'Stripe is a web-based API for accepting payments online.'
+  s.summary                        = 'Accept online payments using Stripe.'
   s.license                        = { :type => 'MIT', :file => 'LICENSE' }
   s.homepage                       = 'https://stripe.com/docs/mobile/ios'
   s.authors                        = { 'Stripe' => '[email protected]' }
   s.source                         = { :git => 'https://github.com/stripe/stripe-ios.git', :tag => "#{s.version}" }
-  s.frameworks                     = 'Foundation', 'Security', 'WebKit', 'PassKit', 'Contacts', 'CoreLocation'
+  s.frameworks                     = 'Foundation', 'Security', 'WebKit', 'PassKit', 'Contacts', 'CoreLocation', 'UIKit'
   s.requires_arc                   = true
   s.platform                       = :ios
   s.ios.deployment_target          = '11.0'

StripeCore.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.homepage                       = 'https://stripe.com/docs/mobile/ios'
   s.authors                        = { 'Stripe' => '[email protected]' }
   s.source                         = { :git => 'https://github.com/stripe/stripe-ios.git', :tag => "#{s.version}" }
-  s.frameworks                     = 'Foundation', 'Security', 'WebKit', 'PassKit', 'Contacts', 'CoreLocation'
+  s.frameworks                     = 'Foundation', 'UIKit'
   s.requires_arc                   = true
   s.platform                       = :ios
   s.ios.deployment_target          = '11.0'

StripeIdentity.podspec

@@ -5,12 +5,12 @@ Pod::Spec.new do |s|
   # Instead, update the VERSION file and run ./ci_scripts/update_version.sh
   s.version                        = '21.7.0'
 
-  s.summary                        = 'StripeIdentity is a web-based API that confirms the identity of global users.'
+  s.summary                        = 'Securely capture ID documents and selfies on iOS for use with Stripe\'s Identity API to confirm the identity of global users.'
   s.license                        = { :type => 'MIT', :file => 'LICENSE' }
-  s.homepage                       = 'https://stripe.com/docs/mobile/ios'
+  s.homepage                       = 'https://stripe.com/identity'
   s.authors                        = { 'Stripe' => '[email protected]' }
   s.source                         = { :git => 'https://github.com/stripe/stripe-ios.git', :tag => "#{s.version}" }
-  s.frameworks                     = 'Foundation', 'Security', 'WebKit', 'PassKit', 'Contacts', 'CoreLocation'
+  s.frameworks                     = 'Foundation', 'WebKit', 'UIKit'
   s.requires_arc                   = true
   s.platform                       = :ios
   s.ios.deployment_target          = '11.0'