Skip to content
Browse files

Add Rakefile for generating documentation

  • Loading branch information...
1 parent 8422853 commit 858101f5a9a1e9c31479645bde9bead6d113bee6 @soffes soffes committed Oct 17, 2011
Showing with 38 additions and 4 deletions.
  1. +1 −4 .gitignore
  2. +36 −0 Rakefile
  3. +1 −0 VERSION
View
5 .gitignore
@@ -1,10 +1,7 @@
.DS_Store
-build
*.mode1v3
*.pbxuser
*.perspectivev3
*.xcworkspace
xcuserdata
-.sass-cache
-Documentation/temp
-Documentation/Output
+Documentation
View
36 Rakefile
@@ -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
View
1 VERSION
@@ -0,0 +1 @@
+0.1.0

0 comments on commit 858101f

Please sign in to comment.
Something went wrong with that request. Please try again.