@@ -1,7 +1,7 @@ #!/usr/bin/env ruby require 'rubygems' require 'oyster' -require 'pdoc' +require File.dirname(__FILE__) + '/../lib/pdoc' spec = Oyster.spec do name "pdoc -- Inline comment parser and JavaScript documentation generator" bin/pdoc @@ -23,13 +23,15 @@ module PDoc FileUtils.mkdir_p(path) Dir.chdir(path) DocPage.new("index", "layout", variables).render_to_file("index.html") + root.sections.each do |section| @depth = 0 mkdir(section.name) render_template('section', "#{section.id}.html", {:doc_instance => section}) - section.children.each{ |d| build_tree(d) } end + root.namespaces.each(&method(:render_namespace)) + copy_assets dest = File.join("javascripts", "item_index.js") @@ -47,16 +49,11 @@ module PDoc FileUtils.cp_r(Dir.glob(File.join(@templates_directory, "assets", "**")), '.') end - def build_tree(object) - @depth += 1 - unless object.children.empty? - mkdir(File.join(path(object), object.id)) - object.children.each { |d| build_tree(d) } - end - template = find_template_name(object) - dest = File.join(path(object), "#{object.id}.html") + def render_namespace(object) + template, path = find_template_name(object), path(object) + @depth = path.size + dest = File.join(path, "#{object.id}.html") render_template(template, dest, {:doc_instance => object}) - @depth -= 1 end private lib/pdoc/generators/html/website.rb @@ -561,7 +561,9 @@ Ajax.PeriodicalUpdater = Klass.create(Ajax.Base, { * a foo bar baz **/ - +/** section: ajax + * class Ajax.Namespace.Manager + **/ /** section: lang * mixin Enumerable test/fixtures/ajax.js @@ -19,7 +19,7 @@ class DocumentationTest < Test::Unit::TestCase klasses).each do |method| assert_respond_to fixtures, method end - assert_equal 32, fixtures.size + assert_equal 33, fixtures.size end def test_globals @@ -27,7 +27,7 @@ class DocumentationTest < Test::Unit::TestCase end def test_descendants - assert_equal %w[$ $$ Ajax Base Element Enumerable Request Responders String Toggle], + assert_equal %w[$ $$ Ajax Base Element Enumerable Manager Request Responders String Toggle], fixtures.descendants.map(&:name).sort end @@ -39,7 +39,7 @@ class DocumentationTest < Test::Unit::TestCase assert_equal %w[ajax dom lang], fixtures.sections.map(&:name) assert_equal [Section, Section, Section], fixtures.sections.map(&:class) assert_equal %w[Ajax], fixtures.sections.first.children.map(&:name) - assert_equal %w[Ajax Base Request Responders], fixtures.sections.first.descendants.map(&:name) + assert_equal %w[Ajax Base Manager Request Responders], fixtures.sections.first.descendants.map(&:name) end def test_find_by_name test/unit/parser/documentation_test.rb a4609a72bd7d8c0c176ac4840f692dbe307eaeeb James Coglan jcoglan@googlemail.com http://github.com/tobie/pdoc/commit/fb90e36b0c114de35f24722baa7fa2b501540c62 fb90e36b0c114de35f24722baa7fa2b501540c62 2009-03-17T07:02:29-07:00 2009-03-17T07:02:29-07:00 Make sure the Website generator makes pages for all declared classes, including ones whose parent object is not documentated. Need to fix navigation template to match. ab655397a5eb3322df11ae0206c58da1a74b87a3 James Coglan jcoglan@googlemail.com