sdoc-helpers 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,48 @@
+sdoc-helpers
+============
+
+Some Rake tasks and hacks to let me easily generate documentation like
+that found at <http://defunkt.github.com/mustache/>.
+
+After installing it, put this in your Rakefile:
+
+    begin
+      require 'sdoc_helpers'
+    rescue LoadError
+      puts "sdoc support not enabled. Please gem install sdoc-helpers."
+    end
+
+Now (with a clean index) run `rake pages:init` to create and publish
+your `gh-pages` branch.
+
+It'll drop you back on master when it's done. Now in the future just
+run `rake pages` to publish sdoc documentation to your `gh-pages`
+branch.
+
+Make sure you don't already have a `docs/` directory. If you do, this
+won't work.
+
+If you README (or any files) end in `md` or `markdown` they'll get
+parsed by `RDiscount` and displayed as Markdown. This gives you a
+nicely formatted README on GitHub as well as in your sdoc.
+
+Enjoy.
+
+
+Dependencies
+------------
+
+* rdiscount
+* sdoc
+
+
+Installation
+------------
+
+    gem install sdoc-helpers
+
+
+Author
+------
+
+Chris Wanstrath // chris@ozmm.org

data/lib/sdoc_helpers/pages.rb

@@ -1,10 +1,12 @@
 require 'rake/rdoctask'
 
 readme = Dir['*'].grep(/README/)[0]
+files = [ readme, 'LICENSE', 'lib' ]
+files.push('CONTRIBUTORS') if Dir['*'].include?('CONTRIBUTORS')
 
 Rake::RDocTask.new do |rdoc|
   rdoc.main = readme
-  rdoc.rdoc_files = [ readme, 'LICENSE', 'lib' ]
+  rdoc.rdoc_files = files
   rdoc.rdoc_dir = 'docs'
 end
 
@@ -14,6 +16,7 @@ namespace :pages do
     `ls -1 | grep -v docs | xargs rm -rf; mv docs/* .; rm -rf docs`
     `git commit -a -m "update docs"; git push origin gh-pages`
     `git checkout master`
+    puts :done
   end
 
   desc "Initialize GitHub Pages with documentation"
@@ -23,6 +26,7 @@ namespace :pages do
     `ls -1 | grep -v docs | xargs rm -rf; mv docs/* .; rm -rf docs`
     `git add .;git commit -m "create docs"; git push origin gh-pages`
     `git checkout master`
+    puts :done
   end
 
   task :check_dirty do

data/lib/sdoc_helpers/version.rb

@@ -1,3 +1,3 @@
 module SDocHelpers
-  Version = '0.1.0'
+  Version = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sdoc-helpers
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 -07:00
+date: 2009-10-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -20,9 +20,9 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 files: 
-- README
+- README.md
 - Rakefile
 - lib/sdoc_helpers.rb
 - lib/sdoc_helpers/markdown.rb