Skip to content

Commit 7347e26

Browse files
committed
Generate documentation with jazzy
1 parent d831acd commit 7347e26

File tree

6 files changed

+43
-0
lines changed

6 files changed

+43
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ xcuserdata
2222
*.moved-aside
2323
*.xcuserstate
2424
*.xcscmblueprint
25+
docs
2526

2627
## Obj-C/Swift specific
2728
*.hmap

.jazzy.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
clean: true
2+
author: polydice
3+
author_url: https://github.com/polydice
4+
github_url: https://github.com/polydice/ICInputAccessory
5+
github_file_prefix: https://github.com/polydice/ICInputAccessory/blob/develop
6+
xcodebuild_arguments: [-scheme, ICInputAccessory-iOS]
7+
module: ICInputAccessory
8+
module_version: 1.1.0
9+
swift_version: 2.2
10+
output: docs/output
11+
theme: apple

.travis.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ matrix:
88
script: bundle exec rake ci:build[latest]
99
- env: BUILD=carthage
1010
script: make carthage
11+
after_script:
12+
- make documentation
1113
cache:
1214
bundler: true
1315
directories:

Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ source "http://rubygems.org"
22
ruby "2.3.1"
33

44
gem "cocoapods", "~> 1.0.0"
5+
gem "jazzy", git: "https://github.com/realm/jazzy.git", ref: "8b88e33"
56
gem "pry"
67
gem "rake"
78
gem "xcpretty"

Gemfile.lock

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
GIT
2+
remote: https://github.com/realm/jazzy.git
3+
revision: 8b88e33d9c6d2d3d0f2958963e4d709304e6b293
4+
ref: 8b88e33
5+
specs:
6+
jazzy (0.7.0)
7+
cocoapods (~> 1.0)
8+
mustache (~> 0.99)
9+
open4
10+
redcarpet (~> 3.2)
11+
rouge (~> 1.5)
12+
sass (~> 3.4)
13+
sqlite3 (~> 1.3)
14+
xcinvoke (~> 0.2.1)
15+
116
GEM
217
remote: http://rubygems.org/
318
specs:
@@ -45,21 +60,29 @@ GEM
4560
fourflusher (0.3.2)
4661
fuzzy_match (2.0.4)
4762
i18n (0.7.0)
63+
liferaft (0.0.4)
4864
method_source (0.8.2)
4965
minitest (5.9.0)
5066
molinillo (0.4.5)
67+
mustache (0.99.8)
5168
nap (1.1.0)
5269
netrc (0.7.8)
70+
open4 (1.3.4)
5371
pry (0.10.4)
5472
coderay (~> 1.1.0)
5573
method_source (~> 0.8.1)
5674
slop (~> 3.4)
5775
rake (11.2.2)
76+
redcarpet (3.3.4)
5877
rouge (1.11.1)
78+
sass (3.4.22)
5979
slop (3.6.0)
80+
sqlite3 (1.3.11)
6081
thread_safe (0.3.5)
6182
tzinfo (1.2.2)
6283
thread_safe (~> 0.1)
84+
xcinvoke (0.2.1)
85+
liferaft (~> 0.0.4)
6386
xcodeproj (1.2.0)
6487
activesupport (>= 3)
6588
claide (>= 1.0.0, < 2.0)
@@ -72,6 +95,7 @@ PLATFORMS
7295

7396
DEPENDENCIES
7497
cocoapods (~> 1.0.0)
98+
jazzy!
7599
pry
76100
rake
77101
xcpretty

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
install: brew-install bundle-install pod-install
22

33
brew-install:
4+
brew update
45
brew tap homebrew/bundle
56
brew bundle
67

@@ -16,3 +17,6 @@ setup: brew-install
1617

1718
carthage:
1819
set -o pipefail && carthage build --no-skip-current --verbose | xcpretty
20+
21+
documentation:
22+
bundle exec jazzy --config .jazzy.yml

0 commit comments

Comments
 (0)