Sha256: d8f3d4f192f9f8ff6f81bc823bdc2600e26440d34ae2a94cd628441f2b7f9e4b

Contents?: true

Size: 1.27 KB

Versions: 16

Compression:

Stored size: 1.27 KB

Contents

require 'yard'
require 'yard/rake/yardoc_task'

GEM_NAME    = File.basename(Dir.pwd)
VENDOR_PATH = File.expand_path(File.join(Dir.pwd, "vendor"))
DOC_PATH    = File.join(VENDOR_PATH, "docs")

namespace :docs do

  YARD::Rake::YardocTask.new(:generate) do |t|
    t.options = ['--verbose', '-o', DOC_PATH]
  end

  namespace :ghpages do

    desc "Clone GitHub pages under vendor"
    task :clone do
      if !File.exists?(DOC_PATH)
        remote = %x(git remote -v | grep 'origin').split[1].strip

        FileUtils.mkdir_p(VENDOR_PATH)
        Dir.chdir(VENDOR_PATH) do
          system(%(git clone --branch gh-pages #{remote} #{DOC_PATH}))
        end
      end
    end

    desc 'Clone, generate and publish YARD Documentation to GitHub pages'
    task :publish do
      Rake::Task["docs:ghpages:clone"].invoke
      Rake::Task["docs:generate"].invoke

      describe = %x(git describe).chomp
      stats    = %x(bundle exec yard stats).chomp

      commit_message = Array.new
      commit_message << "Generated YARD Documentation for #{GEM_NAME.upcase.inspect} #{describe}\n\n"
      commit_message << stats

      Dir.chdir(DOC_PATH) do
        system(%(git add -Av))
        system(%(git commit -m"#{commit_message.join}"))
        system(%(git push origin gh-pages))
      end
    end

  end

end

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
ztk-1.18.1 lib/ztk/rake/docs.rb
ztk-1.18.0 lib/ztk/rake/docs.rb
ztk-1.17.4 lib/ztk/rake/docs.rb
ztk-1.17.3 lib/ztk/rake/docs.rb
ztk-1.17.2 lib/ztk/rake/docs.rb
ztk-1.17.1 lib/ztk/rake/docs.rb
ztk-1.17.0 lib/ztk/rake/docs.rb
ztk-1.16.2 lib/ztk/rake/docs.rb
ztk-1.16.1 lib/ztk/rake/docs.rb
ztk-1.15.3 lib/ztk/rake/docs.rb
ztk-1.15.2 lib/ztk/rake/docs.rb
ztk-1.15.1 lib/ztk/rake/docs.rb
ztk-1.15.0 lib/ztk/rake/docs.rb
ztk-1.14.1 lib/ztk/rake/docs.rb
ztk-1.14.0 lib/ztk/rake/docs.rb
ztk-1.13.0 lib/ztk/rake/docs.rb