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

Commit

Permalink
Add Rakefile for generating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
soffes committed Oct 17, 2011
1 parent 8422853 commit 858101f
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 4 deletions.
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
.DS_Store
build
*.mode1v3
*.pbxuser
*.perspectivev3
*.xcworkspace
xcuserdata
.sass-cache
Documentation/temp
Documentation/Output
Documentation
36 changes: 36 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
appledoc_options = [
'--output Documentation',
'--project-name SSToolkit',
'--project-company \'Sam Soffes\'',
'--company-id com.samsoffes',
"--project-version #{`cat VERSION`.strip}",
'--keep-intermediate-files',
'--create-html',
'--templates ~/Library/Application\ Support/appledoc/Templates/',
'--no-repeat-first-par',
'--verbose']

namespace :docs do
desc 'Clean docs'
task :clean do
`rm -rf Documentation`
end

desc 'Install docs'
task :install => [:'docs:clean'] do
`appledoc #{appledoc_options.join(' ')} --create-docset --install-docset SSToolkit/*.h`
end

desc 'Publish docs'
task :publish => [:'docs:clean'] do
extra_options = [
'--create-docset',
'--publish-docset',
'--install-docset',
'--docset-atom-filename com.samsoffes.sstoolkit.atom',
'--docset-feed-url http://docs.sstoolk.it/%DOCSETATOMFILENAME',
'--docset-package-url http://docs.sstoolk.it/%DOCSETPACKAGEFILENAME'
]
`appledoc #{appledoc_options.join(' ')} #{extra_options.join(' ')} SSToolkit/*.h`
end
end
1 change: 1 addition & 0 deletions VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.1.0

0 comments on commit 858101f

Please sign in to comment.