.gitignore Manifest VERSION.yml @@ -1,45 +1,21 @@ -= SDoc -== What's in? -- shtml - RDoc's generator to build searchable documentation -- <tt>sdoc-merge</tt> - comand line tool to build merge multiple sdoc documentations - packages into a single one -- <tt>sdoc</tt> - command line tool to run rdoc with generator=shtml -- <tt>sdoc-all</tt> - command line tool to get documentation for ruby, rails, gems and plugins in one place += sdoc-all +Command line tool to get documentation for ruby, rails, gems and plugins in one place == Getting Started - gem sources -a http://gems.github.com - sudo gem install voloko-sdoc - sdoc -N projectdir + sudo gem install sdoc sdoc_all + sdoc-all <place for your documentation>; cd <place for your documentation> + rake update -== Command line sdoc -sdoc is simply a wrapper to rdoc command line tool. see <tt>sdoc --help </tt> -for more details. <tt>--fmt</tt> is set to shtml by default. -Default template <tt>-T</tt> is shtml. You can also use 'direct' template. -Example: -<tt>sdoc -o doc/rails -T direct rails</tt> +== Configure +in <tt>sdoc.config.yml</tt> you can define: +- preferred version of ruby +- preferred version of rails +- plugins directory +- what to exclude -== Rake - # Rakefile - require 'sdoc' # and use your RDoc task the same way you used it before - - Rake::RDocTask.new do |rdoc| - rdoc.rdoc_dir = 'doc/rdoc' - rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator - rdoc.template = 'direct' # lighter template used on railsapi.com - ... - end - -== sdoc-merge - Usage: sdoc-merge [options] directories - -n, --names [NAMES] Names of merged repositories. Comma separated - -o, --op [DIRECTORY] Set the output directory - -t, --title [TITLE] Set the title of merged file - -Example: -<tt>sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails" ruby-v1.9 rails-v2.3.2.1</tt> - -== sdoc-all -sdoc-all generates folder with config and rakefile, running <tt>rake</tt> (or <tt>rake update</tt>) in that folder: +== How it works +sdoc-all generates folder with config and rakefile +running <tt>rake update</tt> (or simply <tt>rake</tt> as it is default task) in that folder: - downloads ruby sources from ftp.ruby-lang.org - builds dummy rails applications and freezes gems there - builds documentation for ruby, rails, gems and plugins README.rdoc @@ -1,38 +1,16 @@ -require 'rake/testtask' -require 'rake/gempackagetask' +require 'pathname' +require 'rubygems' +require 'rake' +require 'rake/clean' +require 'fileutils' +require 'echoe' -task :default => :test +version = YAML.load_file(File.join(File.dirname(__FILE__), 'VERSION.yml')).join('.') rescue nil -Rake::TestTask.new("test") do |t| - t.libs << 'test' - t.pattern = 'test/**/*_test.rb' - t.warning = true - t.verbose = true -end - -desc "Generate file list for .gemspec" -task :gem_file_list do - f = FileList.new - f.include('lib/**/**') - f.include('rdoc/**/**') - f.exclude('rdoc/test/**/**') - print "%w(" + f.to_a.select{|file| !File.directory? file }.join(' ') + ")\n" -end - -begin - require 'jeweler' - Jeweler::Tasks.new do |gem| - gem.name = "sdoc" - gem.summary = "rdoc html with javascript search index." - gem.email = "voloko@gmail.com" - gem.homepage = "http://github.com/voloko/sdoc" - gem.authors = ["Volodya Kolesnikov"] - gem.add_dependency("json", ">= 1.1.3") - gem.add_dependency("rdoc", ">= 2.4.2") - gem.add_dependency("rubigen") - - # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings - end -rescue LoadError - puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com" +Echoe.new('sdoc_all', version) do |p| + p.author = "toy" + p.summary = "Command line tool to get documentation for ruby, rails, gems and plugins in one place" + p.url = "http://github.com/toy/sdoc_all" + p.runtime_dependencies = %w(sdoc activesupport rake progress) + p.project = 'toytoy' end Rakefile lib/sdoc/generator/template/direct/resources/apple-touch-icon.png lib/sdoc/generator/template/direct/resources/favicon.ico lib/sdoc/generator/template/shtml/resources/apple-touch-icon.png lib/sdoc/generator/template/shtml/resources/favicon.ico b71c90b5a3f03e0e11b445636265fe1213d7696f Boba Fat ivan@workisfun.ru http://github.com/toy/sdoc_all/commit/4b98ef36a1c1ecda8d5f9fe24d1b7244ff892b2e 4b98ef36a1c1ecda8d5f9fe24d1b7244ff892b2e 2009-04-27T00:09:38-07:00 2009-04-21T17:33:20-07:00 deleted sdoc part 8361af0929dc4c1c8d9b5ccc496777535e8d4b63 Boba Fat ivan@workisfun.ru