sdoc-helpers 0.1.0

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'jeweler'
+
+  $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
+  require 'sdoc_helpers/version'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "sdoc-helpers"
+    gemspec.summary = "Simple helpers to make using sdoc easier."
+    gemspec.description = "Simple helpers to make using sdoc easier."
+    gemspec.email = "chris@ozmm.org"
+    gemspec.homepage = "http://github.com/defunkt/sdoc-helpers"
+    gemspec.authors = ["Chris Wanstrath"]
+    gemspec.version = SDocHelpers::Version.to_s
+  end
+rescue LoadError
+  puts "Jeweler not available."
+  puts "Install it with: gem install jeweler"
+end

data/lib/sdoc_helpers/markdown.rb

@@ -0,0 +1,25 @@
+module SDocHelpers
+  module MarkdownFiles
+    def description
+      return super unless full_name =~ /\.(md|markdown)$/
+      # assuming your path is ROOT/html or ROOT/doc
+      path = Dir.pwd + '/../' + full_name
+      Markdown.new(File.read(path)).to_html + open_links_in_new_window
+    end
+
+    def open_links_in_new_window
+      <<-html
+<script type="text/javascript">$(function() {
+  $('a').each(function() { $(this).attr('target', '_blank') })
+})</script>
+html
+    end
+  end
+end
+
+begin
+  require 'rdiscount'
+  RDoc::TopLevel.send :include, SDocHelpers::MarkdownFiles
+rescue LoadError
+  puts "Markdown support not enabled. Please install RDiscount."
+end

data/lib/sdoc_helpers/pages.rb

@@ -0,0 +1,36 @@
+require 'rake/rdoctask'
+
+readme = Dir['*'].grep(/README/)[0]
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.main = readme
+  rdoc.rdoc_files = [ readme, 'LICENSE', 'lib' ]
+  rdoc.rdoc_dir = 'docs'
+end
+
+namespace :pages do
+  task :publish => [ :check_dirty, :rerdoc ] do
+    `git checkout gh-pages`
+    `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`
+  end
+
+  desc "Initialize GitHub Pages with documentation"
+  task :init => [ :check_dirty, :rerdoc ] do
+    `git symbolic-ref HEAD refs/heads/gh-pages`
+    `rm .git/index`
+    `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`
+  end
+
+  task :check_dirty do
+    if !`git status`.include?('nothing to commit')
+      abort "dirty index - not publishing!"
+    end
+  end
+end
+
+desc "Build and publish documentation using GitHub Pages."
+task :pages => "pages:publish"

data/lib/sdoc_helpers/version.rb

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

data/lib/sdoc_helpers.rb

@@ -0,0 +1,4 @@
+require 'sdoc'
+
+require 'sdoc_helpers/markdown'
+require 'sdoc_helpers/pages'

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: sdoc-helpers
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Wanstrath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple helpers to make using sdoc easier.
+email: chris@ozmm.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- lib/sdoc_helpers.rb
+- lib/sdoc_helpers/markdown.rb
+- lib/sdoc_helpers/pages.rb
+- lib/sdoc_helpers/version.rb
+has_rdoc: true
+homepage: http://github.com/defunkt/sdoc-helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple helpers to make using sdoc easier.
+test_files: []
+