Skip to content
This repository was archived by the owner on Feb 16, 2019. It is now read-only.

Commit 858101f

Browse files
committed
Add Rakefile for generating documentation
1 parent 8422853 commit 858101f

File tree

3 files changed

+38
-4
lines changed

3 files changed

+38
-4
lines changed

.gitignore

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
.DS_Store
2-
build
32
*.mode1v3
43
*.pbxuser
54
*.perspectivev3
65
*.xcworkspace
76
xcuserdata
8-
.sass-cache
9-
Documentation/temp
10-
Documentation/Output
7+
Documentation

Rakefile

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
appledoc_options = [
2+
'--output Documentation',
3+
'--project-name SSToolkit',
4+
'--project-company \'Sam Soffes\'',
5+
'--company-id com.samsoffes',
6+
"--project-version #{`cat VERSION`.strip}",
7+
'--keep-intermediate-files',
8+
'--create-html',
9+
'--templates ~/Library/Application\ Support/appledoc/Templates/',
10+
'--no-repeat-first-par',
11+
'--verbose']
12+
13+
namespace :docs do
14+
desc 'Clean docs'
15+
task :clean do
16+
`rm -rf Documentation`
17+
end
18+
19+
desc 'Install docs'
20+
task :install => [:'docs:clean'] do
21+
`appledoc #{appledoc_options.join(' ')} --create-docset --install-docset SSToolkit/*.h`
22+
end
23+
24+
desc 'Publish docs'
25+
task :publish => [:'docs:clean'] do
26+
extra_options = [
27+
'--create-docset',
28+
'--publish-docset',
29+
'--install-docset',
30+
'--docset-atom-filename com.samsoffes.sstoolkit.atom',
31+
'--docset-feed-url http://docs.sstoolk.it/%DOCSETATOMFILENAME',
32+
'--docset-package-url http://docs.sstoolk.it/%DOCSETPACKAGEFILENAME'
33+
]
34+
`appledoc #{appledoc_options.join(' ')} #{extra_options.join(' ')} SSToolkit/*.h`
35+
end
36+
end

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.1.0

0 commit comments

Comments
 (0)