docapi 0.1.5 → 0.2.0

data/.gitignore

@@ -1,5 +1,4 @@
 *.sw?
 .DS_Store
 coverage
-rdoc
 pkg

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "cyril.rohr@gmail.com"
     gem.homepage = "http://github.com/crohr/docapi"
     gem.authors = ["Cyril Rohr"]
+    gem.add_dependency "rdoc", ">= 2.0.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.2.0

data/bin/docapi

@@ -34,13 +34,11 @@ option_parser.parse!
 
 @command =  ARGV.shift
 
-
-
 case @command
 when 'generate'
-  Docapi.new.generate(input = ARGV, output = @options.delete(:output), @options)
+  Docapi::CLI.new.generate(input = ARGV, output = @options.delete(:output), @options)
 when 'merge'
-  Docapi.new.merge(input = ARGV.shift, output = @options.delete(:output), @options)
+  Docapi::CLI.new.merge(input = ARGV.shift, output = @options.delete(:output), @options)
 else
   $stderr.puts option_parser.help  
   exit(-1)

data/docapi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{docapi}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
-  s.date = %q{2009-12-04}
+  s.date = %q{2010-03-15}
   s.default_executable = %q{docapi}
   s.description = %q{RDoc template for generating API documentation.}
   s.email = %q{cyril.rohr@gmail.com}
@@ -48,6 +48,8 @@ Gem::Specification.new do |s|
      "files/stylesheets/documentation/highlighter/zenburn.css",
      "files/stylesheets/documentation/layout.css",
      "lib/docapi.rb",
+     "lib/rdoc/generator/docapi.rb",
+     "test/Rakefile",
      "test/code/reference_api.rb",
      "test/doc/1-README.md",
      "test/doc/2-documentation/documentation.html",
@@ -68,9 +70,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rdoc>, [">= 2.0.0"])
     else
+      s.add_dependency(%q<rdoc>, [">= 2.0.0"])
     end
   else
+    s.add_dependency(%q<rdoc>, [">= 2.0.0"])
   end
 end
 

data/files/stylesheets/documentation/layout.css

@@ -112,7 +112,7 @@ p.page-title {
   padding-left: 5px;
 }
 table {
-  font-size: 0.8em;
+  font-size: 0.9em;
 }
 
 /*#toc {

data/lib/docapi.rb

@@ -1,150 +1,141 @@
-require 'pathname'
-require 'tempfile'
+require 'yaml'
+require 'haml'
 require 'maruku'
-require 'fileutils'
 
-class Docapi
-  
-  FILES_TO_INCLUDE = {
-    :javascripts => ["./javascripts/documentation/highlight.pack.js", "./javascripts/documentation/jquery-1.3.2.min.js", "./javascripts/documentation/jquery.tableofcontents.min.js", "./javascripts/documentation/documentation.js"],
-    :stylesheets => ["./stylesheets/documentation/layout.css", "./stylesheets/documentation/syntax.css", "./stylesheets/documentation/highlighter/default.css"]
-  }
-  
-  def initialize
+module Docapi
+  class CLI
+
+    TEMPLATE = <<TEMPLATE
+- methods.each do |method|
+  .docapi-subsection
+    .docapi-title
+      %a{:name => method["name"].gsub(/\W/,' ').squeeze(' ').gsub(/\s/,'-')}= method["name"]
+    .docapi-content
+      = method["html_comment"].gsub(/<h2>(.*?)<\\/h2>/m, '<div class="docapi-subtitle">\\1</div>')
+TEMPLATE
+
+    FILES_TO_INCLUDE = {
+      :javascripts => ["./javascripts/documentation/highlight.pack.js", "./javascripts/documentation/jquery-1.3.2.min.js", "./javascripts/documentation/jquery.tableofcontents.min.js", "./javascripts/documentation/documentation.js"],
+      :stylesheets => ["./stylesheets/documentation/layout.css", "./stylesheets/documentation/syntax.css", "./stylesheets/documentation/highlighter/default.css"]
+    }
     
-  end
-  
-  def merge(input_path, output_path, options = {})
-    input_dir = Pathname.new(input_path)
-    raise ArgumentError, "Input directory does not exist" unless input_dir.directory?
-    output_dir = Pathname.new(output_path || Pathname.getwd+"generated-doc")
-    output_dir.mkpath
-    output = File.open(output_dir+"index.html", "w+")
-    output << header(:title => options[:title])
-    output << convert_directory(input_dir)
-    output << footer
-    output.close
-    # copy stylesheets and javascripts files
-    FileUtils.cp_r(File.join(File.dirname(__FILE__), "..", "files", "."), output_dir)
-  end
-  
-  def convert_directory(dir, level = 1)
-    output = []
-    dir.entries.each do |entry|
-      next if entry.to_s =~ /^\./
-      path = dir+entry
-      title = File.basename(entry).gsub(/\d+-/, "").gsub(/\..+?$/, "")
-      output << "<div class='docapi-section #{title.downcase}'>"
-      if path.directory?
-        output << "<h#{level}>#{title.capitalize}</h#{level}>"
-        output << convert_directory(path, level+1)
-      else
-        output << convert_file(path)
-      end  
-      output << '</div>'
+    def merge(input_path, output_path, options = {})
+      input_dir = Pathname.new(input_path)
+      raise ArgumentError, "Input directory does not exist" unless input_dir.directory?
+      output_dir = Pathname.new(output_path || Pathname.getwd+"generated-doc")
+      output_dir.mkpath
+      output = File.open(output_dir+"index.html", "w+")
+      output << header(:title => options[:title])
+      output << convert_directory(input_dir)
+      output << footer
+      output.close
+      # copy stylesheets and javascripts files
+      FileUtils.cp_r(File.join(File.dirname(__FILE__), "..", "files", "."), output_dir)
     end
-    output.flatten
-  end
-  
-  def convert_file(file)
-    case file.extname
-    when ".md"
-      Maruku.new( File.read(file) ).to_html
-    when ".rb"
-      process_file_sections(file, 'ruby', [/^=begin (.*)$/, /^=end$/])
-    when ".py"
-      process_file_sections(file, 'python', [/^''' (.*)$/, /^'''$/])
-    when ".sh"
-      process_file_sections(file, 'bash', [/^<<ENDCOMMENT >\/dev\/null$/, /^ENDCOMMENT$/])
-    when ".html"
-      File.read(file)
+    
+    def convert_directory(dir, level = 1)
+      output = []
+      dir.entries.each do |entry|
+        next if entry.to_s =~ /^\./ || entry.to_s == "created.rid"
+        path = dir+entry
+        title = File.basename(entry).gsub(/\d+-/, "").gsub(/\..+?$/, "")
+        output << "<div class='docapi-section #{title.downcase}'>"
+        if path.directory?
+          output << "<h#{level}>#{title.capitalize}</h#{level}>"
+          output << convert_directory(path, level+1)
+        else
+          output << convert_file(path)
+        end  
+        output << '</div>'
+      end
+      output.flatten
     end
-  end
-  
-  
-  def process_file_sections(file, language, regexps)
-    blocks = []
-    output = ["<div class='docapi-subsection'><div class='docapi-title'>#{File.basename(file).gsub(/^\d+-/, "")}</div>"]
-    File.open(file, "r").each do |line|
-      if line =~ regexps.first
-        output << write_block(blocks.pop)
-        blocks << {:content => "", :language => ($1 || "markdown")}
-      elsif line =~ regexps.last
-        output << write_block(blocks.pop)
-      else
-        blocks << {:content => "", :language => language} if blocks.last.nil?
-        blocks.last[:content] << line
+    
+    def convert_file(file)
+      case file.extname
+      when ".md"
+        Maruku.new( File.read(file) ).to_html
+      when ".rb"
+        process_file_sections(file, 'ruby', [/^=begin (.*)$/, /^=end$/])
+      when ".py"
+        process_file_sections(file, 'python', [/^''' (.*)$/, /^'''$/])
+      when ".sh"
+        process_file_sections(file, 'bash', [/^<<ENDCOMMENT >\/dev\/null$/, /^ENDCOMMENT$/])
+      when ".html"
+        File.read(file)
       end
-    end  
-    output << write_block(blocks.pop)
-    output << '</div>'
-  end
-  
-  def write_block(block)
-    if block
-      case block[:language]
-      when "markdown", "text"
-        Maruku.new( block[:content] ).to_html.gsub(/<pre class='(.+?)'><code>(.*?)<\/code><\/pre>/m, '<pre><code class="\1">\2</code></pre>')
-      else
-        '<pre><code class="'+block[:language]+'">'+block[:content]+'</code></pre>'
+    end
+    
+    
+    def process_file_sections(file, language, regexps)
+      blocks = []
+      output = ["<div class='docapi-subsection'><div class='docapi-title'>#{File.basename(file).gsub(/^\d+-/, "")}</div>"]
+      File.open(file, "r").each do |line|
+        if line =~ regexps.first
+          output << write_block(blocks.pop)
+          blocks << {:content => "", :language => ($1 || "markdown")}
+        elsif line =~ regexps.last
+          output << write_block(blocks.pop)
+        else
+          blocks << {:content => "", :language => language} if blocks.last.nil?
+          blocks.last[:content] << line
+        end
+      end  
+      output << write_block(blocks.pop)
+      output << '</div>'
+    end
+    
+    def write_block(block)
+      if block
+        case block[:language]
+        when "markdown", "text"
+          Maruku.new( block[:content] ).to_html.gsub(/<pre class='(.+?)'><code>(.*?)<\/code><\/pre>/m, '<pre><code class="\1">\2</code></pre>')
+        else
+          '<pre><code class="'+block[:language]+'">'+block[:content]+'</code></pre>'
+        end
       end
     end
-  end
-  
-  def generate(input_paths, output_path, options = {})
-    require 'rdoc'
-    require 'rdoc/rdoc'
-    rdoc_options = %w{-f html --one-file --charset=UTF-8 -U}
-    rdoc_options.concat input_paths
-    output_dir = Pathname.new(output_path || Pathname.getwd+"documentation")
-    raise ArgumentError, "Output directory '#{output_dir}' does not exist" unless output_dir.directory?
-    rdoc_output = Tempfile.new("rdoc_output.html")
-    old_stdout = $stdout
-    begin
-      # redirect stdout to the file
-      $stdout = rdoc_output
+    
+    def generate(input_paths, output_path, options = {})
+      require 'rdoc/generator/docapi'
+      require 'tmpdir'
+      temporary_output_path = File.join(Dir.tmpdir, "docapi")
+      rdoc_options = %w{-f docapi --charset=UTF-8 -U --quiet -o}
+      rdoc_options << temporary_output_path
+      rdoc_options.concat input_paths
+      output_dir = Pathname.new(output_path || Pathname.getwd+"documentation")
+      raise ArgumentError, "Output directory '#{output_dir}' does not exist" unless output_dir.directory?
       RDoc::RDoc.new.document(rdoc_options)
-    ensure
-      $stdout = old_stdout
-    end
-    rdoc_output.rewind
-    documentation = rdoc_output.read
-    rdoc_output.close
-    date = documentation[/<tr><td>Modified:<\/td><td>(.*?)<\/td><\/tr>/, 1]
-    methods = documentation.split("<h4>  method: ")
-    methods.shift
-    methods.map!{ |m| 
-      ["<div class='docapi-subsection'>", m.gsub(/<blockquote><pre>.*/m, "").gsub(/<a name="(.+?)">(.*?)<br \/>\s*?<\/a>/m, "<div class='docapi-title'><a name=\"\\1\">\\2<a></div>").gsub(/<h2>(.*?)<\/h2>/m, "<div class='docapi-subtitle'>\\1</div>").gsub(/<pre>(.*?)<\/pre>/m, "<pre><code>\\1</code></pre>"), "</div>"].join("")
-    }
-
-    File.open(File.join(output_dir.realpath, "documentation.html"), "w+") do |f|
-      # sort methods by :call-seq: length ASC. A bit dirty but...
-      methods.sort_by{|m| method = m[/<div class='docapi-title'><a name=".*?">(.+?)<a><\/div>/, 1].length rescue 0}.each{ |method| f << method }
+      documentation = YAML.load_file(File.join(temporary_output_path, "index.yaml"))
+      html = Haml::Engine.new(TEMPLATE, :ugly => true).render(Object.new, :methods => documentation["methods"], :options => options)  
+      File.open(File.join(output_dir.realpath, "documentation.html"), "w+") do |f|
+        f << html.gsub(/<pre>(.*?)<\/pre>/im, '<pre><code>\1</code></pre>')
+      end
     end
-  end
-  
-  
-  def header(options = {})
-    output = []
-    output << "<html><head><title>#{options[:title] || "Documentation"}</title>"
-    FILES_TO_INCLUDE[:javascripts].each do |file|
-      output << '<script type="text/javascript" src="'+file+'"></script>'
+    
+    
+    def header(options = {})
+      output = []
+      output << "<html><head><title>#{options[:title] || "Documentation"}</title>"
+      FILES_TO_INCLUDE[:javascripts].each do |file|
+        output << '<script type="text/javascript" src="'+file+'"></script>'
+      end
+      FILES_TO_INCLUDE[:stylesheets].each do |file|
+        output << '<link media="screen" type="text/css" href="'+file+'" rel="stylesheet"/>'
+      end
+      output << %Q{
+      <!--[if IE]>
+      <style type="text/css" media="screen">
+        body {padding-right: 320px}
+      </style>
+      <![endif]-->}
+      output << "</head><body>"
     end
-    FILES_TO_INCLUDE[:stylesheets].each do |file|
-      output << '<link media="screen" type="text/css" href="'+file+'" rel="stylesheet"/>'
+    def footer
+      output = []
+      output << "<div id='generation-date'>Generated at: <span class='date'>#{Time.now.to_s}</span></div>"
+      output << "</body></html>"
     end
-    output << %Q{
-  	<!--[if IE]>
-  	<style type="text/css" media="screen">
-  		body {padding-right: 320px}
-  	</style>
-  	<![endif]-->}
-    output << "</head><body>"
-  end
-  def footer
-    output = []
-    output << "<div id='generation-date'>Generated at: <span class='date'>#{Time.now.to_s}</span></div>"
-    output << "</body></html>"
+    
   end
-  
 end

data/lib/rdoc/generator/docapi.rb

@@ -0,0 +1,149 @@
+require 'rubygems'
+gem 'rdoc', '>= 2.0.0'
+
+require 'rdoc/rdoc' unless defined?( RDoc ) && defined?( RDoc::RDoc )
+require 'rdoc/markup/to_html'
+
+require 'pathname'
+# require 'tempfile'
+# require 'maruku'
+require 'fileutils'
+require 'haml'
+
+
+module RDoc
+  module Generator
+    class Docapi
+
+
+      def self.for(options)
+        new(options)
+      end
+  
+      def initialize(options)
+        @options = options
+    
+        # set up a hash to keep track of all the classes/modules we have processed
+        @already_processed = {}
+    
+        # set up a hash to keep track of all of the objects to be output
+        @output = {
+          :files => [], 
+          :classes => [], 
+          :modules => [], 
+          :attributes => [], 
+          :methods => [], 
+          :aliases => [], 
+          :constants => [], 
+          :requires => [], 
+          :includes => []
+        }
+      end
+  
+      # Rdoc passes in TopLevel objects from the code_objects.rb tree (all files)
+      def generate(files)                             
+        # Each object passed in is a file, process it
+        files.each { |file| process_file(file) }
+
+        h = ::RDoc::Markup::ToHtml.new
+        
+        yaml = YAML.dump({
+          "methods" => @output[:methods].map{|method|
+            next if method.visibility == :private
+            {
+              "name" => method.call_seq || method.name,
+              "comment" => method.comment,
+              "html_comment" => method.comment.nil? ? "" : h.convert(method.comment.gsub(/^#+ ?/, ''))
+            }
+          }.compact
+        })
+        
+        puts yaml unless @options.quiet
+        File.open("index.yaml", "w+") do |f|
+           f << yaml
+         end
+      end
+  
+      private
+
+      # process a file from the code_object.rb tree
+      def process_file(file)
+        @output[:files].push(file)
+
+        puts "#{file.comment}"
+        
+        # Process all of the objects that this file contains
+        file.method_list.each { |child| process_method(child) }
+        file.aliases.each { |child| process_alias(child) }
+        file.constants.each { |child| process_constant(child) }
+        file.requires.each { |child| process_require(child) }
+        file.includes.each { |child| process_include(child) }
+        file.attributes.each { |child| process_attribute(child) }   
+  
+        # Recursively process contained subclasses and modules 
+        file.each_classmodule do |child| 
+            process_class_or_module(child)      
+        end
+      end
+
+      # Process classes and modiles   
+      def process_class_or_module(obj)
+        obj.class == Module ? type = :modules : type = :classes
+
+        # One important note about the code_objects.rb structure. A class or module
+        # definition can be spread a cross many files in Ruby so code_objects.rb handles
+        # this by keeping only *one* reference to each class or module that has a definition
+        # at the root level of a file (ie. not contained in another class or module).
+        # This means that when we are processing files we may run into the same class/module
+        # twice. So we need to keep track of what classes/modules we have
+        # already seen and make sure we don't create two INSERT statements for the same
+        # object.
+        if(!@already_processed.has_key?(obj.full_name)) then      
+          @output[type].push(obj)
+          @already_processed[obj.full_name] = true
+
+          # Process all of the objects that this class or module contains
+          obj.method_list.each { |child| process_method(child) }
+          obj.aliases.each { |child| process_alias(child) }
+          obj.constants.each { |child| process_constant(child) }
+          obj.requires.each { |child| process_require(child) }
+          obj.includes.each { |child| process_include(child) }
+          obj.attributes.each { |child| process_attribute(child) }   
+        end
+
+        id = @already_processed[obj.full_name]
+        # Recursively process contained subclasses and modules 
+        obj.each_classmodule do |child| 
+        	process_class_or_module(child) 
+        end
+      end       
+
+      def process_method(obj)  
+        @output[:methods].push(obj)                                
+      end
+
+      def process_alias(obj)
+        @output[:aliases].push(obj)  
+      end
+
+      def process_constant(obj)
+        @output[:constants].push(obj)    
+      end
+
+      def process_attribute(obj)
+        @output[:attributes].push(obj)     
+      end
+
+      def process_require(obj)
+        @output[:requires].push(obj) 
+      end
+
+      def process_include(obj) 
+        @output[:includes].push(obj)     
+      end   
+    end
+
+  end
+end
+
+RDoc::RDoc.add_generator RDoc::Generator::Docapi

data/test/Rakefile

@@ -0,0 +1,19 @@
+
+namespace :test do
+  desc "Attempts to generate the list of methods"
+  task :generate do
+    $LOAD_PATH.unshift File.dirname(__FILE__)+'/../lib'
+    require 'docapi'
+    require 'rdoc/generator/docapi'
+    Docapi::CLI.new.generate(["code/reference_api.rb"], "doc/2-documentation")
+    # RDoc::RDoc.new.document(["-f", "docapi", "-U", "-q", "-o", "doc/2-documentation", "code/reference_api.rb"])
+  end
+  
+  desc "Attempts to merge"
+  task :merge => :generate do
+    $LOAD_PATH.unshift File.dirname(__FILE__)+'/../lib'
+    require 'docapi'
+    require 'rdoc/generator/docapi'
+    Docapi::CLI.new.merge("doc", "output", :title => "Reference API Documentation")
+  end
+end

data/test/doc/2-documentation/documentation.html

@@ -1,74 +1,13 @@
-<ol class="methods"><li>
-
-<div class="synopsis"><a name="M000003">GET /:grid5000-resource[.:format]<a></div>
-
-
-
-
-<p>
-Get a specific version of a Grid5000 resource.
-</p>
-<h2>URI parameters</h2>
-<table>
-<tr><td valign="top"><tt>grid5000-resource</tt>:</td><td>the URI of the grid5000 resource.
-
-</td></tr>
-</table>
-<h2>Query parameters</h2>
-<table>
-<tr><td valign="top"><tt>version</tt>:</td><td>the requested version. It can be a version id (40 characters), or a UNIX
-timestamp [default=empty (most recent version is used)].
-
-</td></tr>
-<tr><td valign="top"><tt>depth</tt>:</td><td>the number of nested sub-resources to resolve [default=1].
-
-</td></tr>
-<tr><td valign="top"><tt>resolve</tt>:</td><td>a list of comma separated sub-resources names to resolve (to be used with
-the <tt>depth</tt> parameter) [default=all].
-
-</td></tr>
-</table>
-<h2>Content-Types</h2>
-<table>
-<tr><td valign="top"><tt>application/json</tt>:</td><td>JSON
-
-</td></tr>
-<tr><td valign="top"><tt>application/xml</tt>:</td><td>XML
-
-</td></tr>
-<tr><td valign="top"><tt>application/zip</tt>:</td><td>the ZIP format will return a zip archive containing the set of directories
-and files corresponding to the required data, with all its sub-resources.
-
-</td></tr>
-</table>
-<h2>Status codes</h2>
-<table>
-<tr><td valign="top"><tt>200</tt>:</td><td>OK, the response contains the description of the resource as it was at the
-requested version.
-
-</td></tr>
-<tr><td valign="top"><tt>404</tt>:</td><td>the requested grid5000 resource cannot be found, or the requested version
-does not exist.
-
-</td></tr>
-<tr><td valign="top"><tt>406</tt>:</td><td>Returns 406 if the requested format is not available.
-
-</td></tr>
-</table>
-
-
-
-</li><li>
-
-<div class="synopsis"><a name="M000001">GET /:grid5000-resource/versions[.:format]<a></div>
-
-
-
-
+<div class='docapi-subsection'>
+<div class='docapi-title'>
+<a name='GET-/:grid5000-resource/versions[.:format]'>GET /:grid5000-resource/versions[.:format]
+</a>
+</div>
+<div class='docapi-content'>
 <p>
 Get the list of all versions of a particular resource.
 </p>
-<h2>URI parameters</h2>
+<div class="docapi-subtitle">URI parameters</div>
 <table>
 <tr><td valign="top"><tt>grid5000-resource</tt>:</td><td>the URI of the grid5000 resource.
 
@@ -78,13 +17,13 @@ header in your HTTP request.
 
 </td></tr>
 </table>
-<h2>Query parameters</h2>
+<div class="docapi-subtitle">Query parameters</div>
 <table>
 <tr><td valign="top"><tt>limit</tt>:</td><td>maximum number of versions to return.
 
 </td></tr>
 </table>
-<h2>Content-Types</h2>
+<div class="docapi-subtitle">Content-Types</div>
 <table>
 <tr><td valign="top"><tt>application/json</tt>:</td><td>JSON
 
@@ -93,7 +32,7 @@ header in your HTTP request.
 
 </td></tr>
 </table>
-<h2>Status codes</h2>
+<div class="docapi-subtitle">Status codes</div>
 <table>
 <tr><td valign="top"><tt>200</tt>:</td><td>OK, the response contains the list of the versions of the requested
 grid5000 resource.
@@ -106,7 +45,7 @@ grid5000 resource.
 
 </td></tr>
 </table>
-<h2>Usage</h2>
+<div class="docapi-subtitle">Usage</div>
 <p>
 Get the 2 latest versions of the Rennes site:
 </p>
@@ -137,50 +76,107 @@ Get the 2 latest versions of the Rennes site:
     ]
 </code></pre>
 
+</div>
+</div>
+<div class='docapi-subsection'>
+<div class='docapi-title'>
+<a name='GET-/:grid5000-resource/versions/:version[.:format]'>GET /:grid5000-resource/versions/:version[.:format]
+</a>
+</div>
+<div class='docapi-content'>
+<p>
+Get info about a specific version.
+</p>
+<div class="docapi-subtitle">URI parameters</div>
+<table>
+<tr><td valign="top"><tt>grid5000-resource</tt>:</td><td>the URI of the grid5000 resource.
 
+</td></tr>
+<tr><td valign="top"><tt>version</tt>:</td><td>the version id (40 characters long) or a UNIX timestamp.
 
-</li><li>
+</td></tr>
+</table>
+<div class="docapi-subtitle">Content-Types</div>
+<table>
+<tr><td valign="top"><tt>application/json</tt>:</td><td>JSON
 
-<div class="synopsis"><a name="M000002">GET /:grid5000-resource/versions/:version[.:format]<a></div>
+</td></tr>
+<tr><td valign="top"><tt>application/xml</tt>:</td><td>XML
 
+</td></tr>
+</table>
+<div class="docapi-subtitle">Status codes</div>
+<table>
+<tr><td valign="top"><tt>200</tt>:</td><td>OK.
 
+</td></tr>
+<tr><td valign="top"><tt>404</tt>:</td><td>the requested grid5000 resource cannot be found, or the requested version
+does not exist.
+
+</td></tr>
+<tr><td valign="top"><tt>406</tt>:</td><td>the requested format is not available.
 
+</td></tr>
+</table>
 
+</div>
+</div>
+<div class='docapi-subsection'>
+<div class='docapi-title'>
+<a name='GET-/:grid5000-resource[.:format]'>GET /:grid5000-resource[.:format]
+</a>
+</div>
+<div class='docapi-content'>
 <p>
-Get info about a specific version.
+Get a specific version of a Grid5000 resource.
 </p>
-<h2>URI parameters</h2>
+<div class="docapi-subtitle">URI parameters</div>
 <table>
 <tr><td valign="top"><tt>grid5000-resource</tt>:</td><td>the URI of the grid5000 resource.
 
 </td></tr>
-<tr><td valign="top"><tt>version</tt>:</td><td>the version id (40 characters long) or a UNIX timestamp.
+</table>
+<div class="docapi-subtitle">Query parameters</div>
+<table>
+<tr><td valign="top"><tt>version</tt>:</td><td>the requested version. It can be a version id (40 characters), or a UNIX
+timestamp [default=empty (most recent version is used)].
+
+</td></tr>
+<tr><td valign="top"><tt>depth</tt>:</td><td>the number of nested sub-resources to resolve [default=1].
+
+</td></tr>
+<tr><td valign="top"><tt>resolve</tt>:</td><td>a list of comma separated sub-resources names to resolve (to be used with
+the <tt>depth</tt> parameter) [default=all].
 
 </td></tr>
 </table>
-<h2>Content-Types</h2>
+<div class="docapi-subtitle">Content-Types</div>
 <table>
 <tr><td valign="top"><tt>application/json</tt>:</td><td>JSON
 
 </td></tr>
 <tr><td valign="top"><tt>application/xml</tt>:</td><td>XML
 
+</td></tr>
+<tr><td valign="top"><tt>application/zip</tt>:</td><td>the ZIP format will return a zip archive containing the set of directories
+and files corresponding to the required data, with all its sub-resources.
+
 </td></tr>
 </table>
-<h2>Status codes</h2>
+<div class="docapi-subtitle">Status codes</div>
 <table>
-<tr><td valign="top"><tt>200</tt>:</td><td>OK.
+<tr><td valign="top"><tt>200</tt>:</td><td>OK, the response contains the description of the resource as it was at the
+requested version.
 
 </td></tr>
 <tr><td valign="top"><tt>404</tt>:</td><td>the requested grid5000 resource cannot be found, or the requested version
 does not exist.
 
 </td></tr>
-<tr><td valign="top"><tt>406</tt>:</td><td>the requested format is not available.
+<tr><td valign="top"><tt>406</tt>:</td><td>Returns 406 if the requested format is not available.
 
 </td></tr>
 </table>
 
-
-
-</li></ol>
+</div>
+</div>

data/test/doc/3-tutorials/2-ruby/example-1.rb

@@ -1,9 +1,11 @@
 =begin markdown
 Comment `code` is good.
 =end
-def x
+
+def method
   return "whatever"
 end
+
 =begin markdown
 Comment
 =end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: docapi
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-04 00:00:00 +01:00
+date: 2010-03-15 00:00:00 +01:00
 default_executable: docapi
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
 description: RDoc template for generating API documentation.
 email: cyril.rohr@gmail.com
 executables: 
@@ -52,6 +61,8 @@ files:
 - files/stylesheets/documentation/highlighter/zenburn.css
 - files/stylesheets/documentation/layout.css
 - lib/docapi.rb
+- lib/rdoc/generator/docapi.rb
+- test/Rakefile
 - test/code/reference_api.rb
 - test/doc/1-README.md
 - test/doc/2-documentation/documentation.html