This repository has been archived by the owner on Feb 16, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 573
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Rakefile for generating documentation
- Loading branch information
Showing
3 changed files
with
38 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
0.1.0 |