Skip to content

Commit eacdd1a

Browse files
authored
Merge pull request #26 from bcylin/master
Use master branch /docs folder for GitHub Pages
2 parents 3639c3c + 1057e22 commit eacdd1a

26 files changed

+4267
-37
lines changed

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,16 @@ xcuserdata
2222
*.moved-aside
2323
*.xcuserstate
2424
*.xcscmblueprint
25-
docs
2625

2726
## Obj-C/Swift specific
2827
*.hmap
2928
*.ipa
3029

30+
## Docs
31+
undocumented.json
32+
*.docset
33+
*.tgz
34+
3135
## CocoaPods
3236
Pods/
3337

.jazzy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ github_file_prefix: https://github.com/polydice/ICInputAccessory/blob/develop
66
xcodebuild_arguments: [-project, ICInputAccessory.xcodeproj, -scheme, ICInputAccessory-iOS]
77
module: ICInputAccessory
88
module_version: 1.5.0
9-
output: docs/output
9+
output: docs
1010
theme: fullwidth
1111
skip_undocumented: true

.travis.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ script:
1717
- bundle exec rake ci:test
1818
- make -B carthage
1919
- make -B docs
20-
after_script:
21-
- sh scripts/update-docs.sh
2220
notifications:
2321
email: false
2422
slack:

Makefile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ carthage:
2424
set -o pipefail && carthage build --no-skip-current --verbose | bundle exec xcpretty
2525

2626
docs:
27-
test -d docs || git clone -b gh-pages --single-branch https://github.com/polydice/ICInputAccessory.git docs
28-
cd docs && git fetch origin gh-pages && git clean -f -d
29-
cd docs && git checkout gh-pages && git reset --hard origin/gh-pages
3027
bundle exec jazzy --config .jazzy.yml
28+
for file in "html" "css" "js" "json"; do \
29+
echo "Trimming whitespace in *."$$file ; \
30+
find docs -name "*."$$file -exec sed -E -i "" -e "s/[[:blank:]]*$$//" {} \; ; \
31+
done

docs/Classes.html

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Classes Reference</title>
5+
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
7+
<meta charset="utf-8">
8+
<script src="js/jquery.min.js" defer></script>
9+
<script src="js/jazzy.js" defer></script>
10+
11+
<script src="js/lunr.min.js" defer></script>
12+
<script src="js/typeahead.jquery.js" defer></script>
13+
<script src="js/jazzy.search.js" defer></script>
14+
</head>
15+
<body>
16+
17+
18+
<a title="Classes Reference"></a>
19+
20+
<header class="header">
21+
<p class="header-col header-col--primary">
22+
<a class="header-link" href="index.html">
23+
ICInputAccessory Docs
24+
</a>
25+
(71% documented)
26+
</p>
27+
28+
<p class="header-col--secondary">
29+
<form role="search" action="search.json">
30+
<input type="text" placeholder="Search documentation" data-typeahead>
31+
</form>
32+
</p>
33+
34+
<p class="header-col header-col--secondary">
35+
<a class="header-link" href="https://github.com/polydice/ICInputAccessory">
36+
<img class="header-icon" src="img/gh.png"/>
37+
View on GitHub
38+
</a>
39+
</p>
40+
41+
</header>
42+
43+
<p class="breadcrumbs">
44+
<a class="breadcrumb" href="index.html">ICInputAccessory Reference</a>
45+
<img class="carat" src="img/carat.png" />
46+
Classes Reference
47+
</p>
48+
49+
<div class="content-wrapper">
50+
<nav class="navigation">
51+
<ul class="nav-groups">
52+
<li class="nav-group-name">
53+
<a class="nav-group-name-link" href="Classes.html">Classes</a>
54+
<ul class="nav-group-tasks">
55+
<li class="nav-group-task">
56+
<a class="nav-group-task-link" href="Classes/ICKeyboardDismissAccessoryView.html">ICKeyboardDismissAccessoryView</a>
57+
</li>
58+
<li class="nav-group-task">
59+
<a class="nav-group-task-link" href="Classes/ICKeyboardDismissTextField.html">ICKeyboardDismissTextField</a>
60+
</li>
61+
<li class="nav-group-task">
62+
<a class="nav-group-task-link" href="Classes/ICTokenField.html">ICTokenField</a>
63+
</li>
64+
</ul>
65+
</li>
66+
<li class="nav-group-name">
67+
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
68+
<ul class="nav-group-tasks">
69+
<li class="nav-group-task">
70+
<a class="nav-group-task-link" href="Protocols/ICTokenFieldDelegate.html">ICTokenFieldDelegate</a>
71+
</li>
72+
</ul>
73+
</li>
74+
</ul>
75+
</nav>
76+
<article class="main-content">
77+
78+
<section class="section">
79+
<div class="section-content">
80+
<h1>Classes</h1>
81+
<p>The following classes are available globally.</p>
82+
83+
</div>
84+
</section>
85+
86+
<section class="section">
87+
<div class="section-content">
88+
<div class="task-group">
89+
<ul class="item-container">
90+
<li class="item">
91+
<div>
92+
<code>
93+
<a name="/c:@M@ICInputAccessory@objc(cs)ICKeyboardDismissAccessoryView"></a>
94+
<a name="//apple_ref/swift/Class/ICKeyboardDismissAccessoryView" class="dashAnchor"></a>
95+
<a class="token" href="#/c:@M@ICInputAccessory@objc(cs)ICKeyboardDismissAccessoryView">ICKeyboardDismissAccessoryView</a>
96+
</code>
97+
</div>
98+
<div class="height-container">
99+
<div class="pointer-container"></div>
100+
<section class="section">
101+
<div class="pointer"></div>
102+
<div class="abstract">
103+
<p>A customized keyboard accessory view with a dismiss button.</p>
104+
105+
<a href="Classes/ICKeyboardDismissAccessoryView.html" class="slightly-smaller">See more</a>
106+
</div>
107+
<div class="declaration">
108+
<h4>Declaration</h4>
109+
<div class="language">
110+
<p class="aside-title">Swift</p>
111+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ICKeyboardDismissAccessoryView</span><span class="p">:</span> <span class="kt">UIView</span></code></pre>
112+
113+
</div>
114+
</div>
115+
<div class="slightly-smaller">
116+
<a href="https://github.com/polydice/ICInputAccessory/blob/develop/Source/KeyboardDismissTextField/ICKeyboardDismissAccessoryView.swift#L31-L131">Show on GitHub</a>
117+
</div>
118+
</section>
119+
</div>
120+
</li>
121+
</ul>
122+
</div>
123+
<div class="task-group">
124+
<ul class="item-container">
125+
<li class="item">
126+
<div>
127+
<code>
128+
<a name="/c:@M@ICInputAccessory@objc(cs)ICKeyboardDismissTextField"></a>
129+
<a name="//apple_ref/swift/Class/ICKeyboardDismissTextField" class="dashAnchor"></a>
130+
<a class="token" href="#/c:@M@ICInputAccessory@objc(cs)ICKeyboardDismissTextField">ICKeyboardDismissTextField</a>
131+
</code>
132+
</div>
133+
<div class="height-container">
134+
<div class="pointer-container"></div>
135+
<section class="section">
136+
<div class="pointer"></div>
137+
<div class="abstract">
138+
<p>A text field that has a button to dismiss keyboard on the input accessory view.</p>
139+
140+
<a href="Classes/ICKeyboardDismissTextField.html" class="slightly-smaller">See more</a>
141+
</div>
142+
<div class="declaration">
143+
<h4>Declaration</h4>
144+
<div class="language">
145+
<p class="aside-title">Swift</p>
146+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ICKeyboardDismissTextField</span><span class="p">:</span> <span class="kt">UITextField</span></code></pre>
147+
148+
</div>
149+
</div>
150+
<div class="slightly-smaller">
151+
<a href="https://github.com/polydice/ICInputAccessory/blob/develop/Source/KeyboardDismissTextField/ICKeyboardDismissTextField.swift#L31-L82">Show on GitHub</a>
152+
</div>
153+
</section>
154+
</div>
155+
</li>
156+
</ul>
157+
</div>
158+
<div class="task-group">
159+
<ul class="item-container">
160+
<li class="item">
161+
<div>
162+
<code>
163+
<a name="/c:@M@ICInputAccessory@objc(cs)ICTokenField"></a>
164+
<a name="//apple_ref/swift/Class/ICTokenField" class="dashAnchor"></a>
165+
<a class="token" href="#/c:@M@ICInputAccessory@objc(cs)ICTokenField">ICTokenField</a>
166+
</code>
167+
</div>
168+
<div class="height-container">
169+
<div class="pointer-container"></div>
170+
<section class="section">
171+
<div class="pointer"></div>
172+
<div class="abstract">
173+
<p>A text field that groups input texts with delimiters.</p>
174+
175+
<a href="Classes/ICTokenField.html" class="slightly-smaller">See more</a>
176+
</div>
177+
<div class="declaration">
178+
<h4>Declaration</h4>
179+
<div class="language">
180+
<p class="aside-title">Swift</p>
181+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ICTokenField</span><span class="p">:</span> <span class="kt">UIView</span><span class="p">,</span> <span class="kt">UITextFieldDelegate</span><span class="p">,</span> <span class="kt">ICBackspaceTextFieldDelegate</span></code></pre>
182+
183+
</div>
184+
</div>
185+
<div class="slightly-smaller">
186+
<a href="https://github.com/polydice/ICInputAccessory/blob/develop/Source/TokenField/ICTokenField.swift#L52-L482">Show on GitHub</a>
187+
</div>
188+
</section>
189+
</div>
190+
</li>
191+
</ul>
192+
</div>
193+
</div>
194+
</section>
195+
196+
</article>
197+
</div>
198+
<section class="footer">
199+
<p>&copy; 2018 <a class="link" href="https://github.com/polydice" target="_blank" rel="external">polydice</a>. All rights reserved. (Last updated: 2018-04-12)</p>
200+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
201+
</section>
202+
</body>
203+
</div>
204+
</html>

0 commit comments

Comments
 (0)