@@ -1,7 +1,38 @@ -== Searchable rdoc -rdoc html with javascript search index. -See online on railsapi.com += 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 -== Usage -sudo gem install voloko-sdoc --source http://gems.github.com -sdoc -N projectdir \ No newline at end of file +== Getting Started + gem sources -a http://gems.github.com + sudo gem install voloko-sdoc + sdoc -N projectdir + +== 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> + +== 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> \ No newline at end of file README.rdoc @@ -2,15 +2,15 @@ Gem::Specification.new do |s| s.name = %q{sdoc} - s.version = "0.2.5" + s.version = "0.2.6" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Volodya Kolesnikov"] - s.date = %q{2009-04-06} + s.date = %q{2009-04-08} s.email = %q{voloko@gmail.com} s.executables = ["sdoc", "sdoc-merge"] - s.extra_rdoc_files = ["README", "LICENSE"] - s.files = ["VERSION.yml", "bin/sdoc", "bin/sdoc-merge", "lib/sdoc", "lib/sdoc/c_parser_fix.rb", "lib/sdoc/generator", "lib/sdoc/generator/shtml.rb", "lib/sdoc/generator/template", "lib/sdoc/generator/template/direct", "lib/sdoc/generator/template/direct/_context.rhtml", "lib/sdoc/generator/template/direct/class.rhtml", "lib/sdoc/generator/template/direct/file.rhtml", "lib/sdoc/generator/template/direct/index.rhtml", "lib/sdoc/generator/template/direct/resources", "lib/sdoc/generator/template/direct/resources/css", "lib/sdoc/generator/template/direct/resources/css/main.css", "lib/sdoc/generator/template/direct/resources/css/panel.css", "lib/sdoc/generator/template/direct/resources/css/reset.css", "lib/sdoc/generator/template/direct/resources/i", "lib/sdoc/generator/template/direct/resources/i/arrows.png", "lib/sdoc/generator/template/direct/resources/i/results_bg.png", "lib/sdoc/generator/template/direct/resources/i/tree_bg.png", "lib/sdoc/generator/template/direct/resources/js", "lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js", "lib/sdoc/generator/template/direct/resources/js/jquery-effect.js", "lib/sdoc/generator/template/direct/resources/js/main.js", "lib/sdoc/generator/template/direct/resources/js/searchdoc.js", "lib/sdoc/generator/template/direct/resources/panel", "lib/sdoc/generator/template/direct/resources/panel/index.html", "lib/sdoc/generator/template/merge", "lib/sdoc/generator/template/merge/index.rhtml", "lib/sdoc/generator/template/shtml", "lib/sdoc/generator/template/shtml/_context.rhtml", "lib/sdoc/generator/template/shtml/class.rhtml", "lib/sdoc/generator/template/shtml/file.rhtml", "lib/sdoc/generator/template/shtml/index.rhtml", "lib/sdoc/generator/template/shtml/resources", "lib/sdoc/generator/template/shtml/resources/css", "lib/sdoc/generator/template/shtml/resources/css/main.css", "lib/sdoc/generator/template/shtml/resources/css/panel.css", "lib/sdoc/generator/template/shtml/resources/css/reset.css", "lib/sdoc/generator/template/shtml/resources/i", "lib/sdoc/generator/template/shtml/resources/i/arrows.png", "lib/sdoc/generator/template/shtml/resources/i/results_bg.png", "lib/sdoc/generator/template/shtml/resources/i/tree_bg.png", "lib/sdoc/generator/template/shtml/resources/js", "lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js", "lib/sdoc/generator/template/shtml/resources/js/main.js", "lib/sdoc/generator/template/shtml/resources/js/searchdoc.js", "lib/sdoc/generator/template/shtml/resources/panel", "lib/sdoc/generator/template/shtml/resources/panel/index.html", "lib/sdoc/github.rb", "lib/sdoc/helpers.rb", "lib/sdoc/merge.rb", "lib/sdoc/templatable.rb", "lib/sdoc.rb", "README", "LICENSE"] + s.extra_rdoc_files = ["README.rdoc", "LICENSE"] + s.files = ["README.rdoc", "VERSION.yml", "bin/sdoc", "bin/sdoc-merge", "lib/sdoc", "lib/sdoc/c_parser_fix.rb", "lib/sdoc/generator", "lib/sdoc/generator/shtml.rb", "lib/sdoc/generator/template", "lib/sdoc/generator/template/direct", "lib/sdoc/generator/template/direct/_context.rhtml", "lib/sdoc/generator/template/direct/class.rhtml", "lib/sdoc/generator/template/direct/file.rhtml", "lib/sdoc/generator/template/direct/index.rhtml", "lib/sdoc/generator/template/direct/resources", "lib/sdoc/generator/template/direct/resources/css", "lib/sdoc/generator/template/direct/resources/css/main.css", "lib/sdoc/generator/template/direct/resources/css/panel.css", "lib/sdoc/generator/template/direct/resources/css/reset.css", "lib/sdoc/generator/template/direct/resources/i", "lib/sdoc/generator/template/direct/resources/i/arrows.png", "lib/sdoc/generator/template/direct/resources/i/results_bg.png", "lib/sdoc/generator/template/direct/resources/i/tree_bg.png", "lib/sdoc/generator/template/direct/resources/js", "lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js", "lib/sdoc/generator/template/direct/resources/js/jquery-effect.js", "lib/sdoc/generator/template/direct/resources/js/main.js", "lib/sdoc/generator/template/direct/resources/js/searchdoc.js", "lib/sdoc/generator/template/direct/resources/panel", "lib/sdoc/generator/template/direct/resources/panel/index.html", "lib/sdoc/generator/template/merge", "lib/sdoc/generator/template/merge/index.rhtml", "lib/sdoc/generator/template/shtml", "lib/sdoc/generator/template/shtml/_context.rhtml", "lib/sdoc/generator/template/shtml/class.rhtml", "lib/sdoc/generator/template/shtml/file.rhtml", "lib/sdoc/generator/template/shtml/index.rhtml", "lib/sdoc/generator/template/shtml/resources", "lib/sdoc/generator/template/shtml/resources/css", "lib/sdoc/generator/template/shtml/resources/css/main.css", "lib/sdoc/generator/template/shtml/resources/css/panel.css", "lib/sdoc/generator/template/shtml/resources/css/reset.css", "lib/sdoc/generator/template/shtml/resources/i", "lib/sdoc/generator/template/shtml/resources/i/arrows.png", "lib/sdoc/generator/template/shtml/resources/i/results_bg.png", "lib/sdoc/generator/template/shtml/resources/i/tree_bg.png", "lib/sdoc/generator/template/shtml/resources/js", "lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js", "lib/sdoc/generator/template/shtml/resources/js/main.js", "lib/sdoc/generator/template/shtml/resources/js/searchdoc.js", "lib/sdoc/generator/template/shtml/resources/panel", "lib/sdoc/generator/template/shtml/resources/panel/index.html", "lib/sdoc/github.rb", "lib/sdoc/helpers.rb", "lib/sdoc/merge.rb", "lib/sdoc/templatable.rb", "lib/sdoc.rb", "LICENSE"] s.has_rdoc = true s.homepage = %q{http://github.com/voloko/sdoc} s.rdoc_options = ["--inline-source", "--charset=UTF-8"] sdoc.gemspec f96bfee4072f95ae2ff77c78896da60b38bf3d6a Volodya Kolesnikov voloko@gmail.com http://github.com/voloko/sdoc/commit/46dd27706df655c2ec4fe7fd6052e52dd5c8bdf0 46dd27706df655c2ec4fe7fd6052e52dd5c8bdf0 2009-04-08T01:30:32-07:00 2009-04-08T01:30:32-07:00 rdoc readme, layout fixes release b75b5b2a1a0a19a0c418458c8f7c9d67796b3311 Volodya Kolesnikov voloko@gmail.com