Forum: Ruby rake and rdoc help needed - target seems to be generated twi

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
6559f9b9607a89074ea5e238d31ffbc2?d=identicon&s=25 Kelly Felkins (Guest)
on 2006-04-05 03:15
(Received via mailing list)
Hello,

I set up some rake tasks to generate documentation for my rails app. I
started with the doc:app task from rails and the rdoctask in rake
definitions. I'm learning rake so please go easy on me.  ;-) Here is
what I
came up with:

desc "Generate API Documentation"
SRC =
FileList['doc/README_FOR_APP','doc/REQUIREMENTS','doc/DESIGN','app/**/*.rb']
file "doc/app/index.html" => SRC do
  rm Dir.glob('doc/app/**/*.html')
  require 'rdoc/rdoc'
  options = []
  options << "-o" << 'doc/app'
  options << "--title" << "Goals System"
  RDoc::RDoc.new.document( options+SRC )
end

task :gendocs => "doc/app/index.html"

desc "Clobber API Documentation"
task :clobberdocs do
  rm Dir.glob('doc/app/**/*.html')
end


When I do

 rake --trace gendocs

It appears the documentation is generated, then deleted, then generated
again.

???

That's my question -- why does it generate, delete, and then generate it
again.


Additional background:

I'm trying to address 2 problems:

   1. I want to include doc/REQUIREMENTS, and doc/DESIGN in my rdoc run.
   2. We have a policy here of saving generated documentation in cvs.
The
   rdoctask that comes with rake does a rm_r, deleting everything in the
target
   directory including .CVS files. This makes it difficult to do a
commit to
   cvs.

Thank you.

-Kelly
10d4acbfdaccb4eee687a428ca00a5d8?d=identicon&s=25 Jim Weirich (weirich)
on 2006-04-05 06:24
Kelly Felkins wrote:
> I set up some rake tasks to generate documentation for my rails app.
[...]
> When I do
>
>  rake --trace gendocs
>
> It appears the documentation is generated, then deleted, then generated
> again.
>
> ???
>
> That's my question -- why does it generate, delete, and then generate it
> again.

I'm getting this:

-------------------------------------------
$ rake gendocs --trace
(in /media/hda5/jim/pgm/ruby/rake/docapi)
** Invoke gendocs (first_time)
** Invoke doc/app/index.html (first_time)
** Invoke doc/README_FOR_APP (first_time, not_needed)
** Invoke doc/REQUIREMENTS (first_time, not_needed)
** Invoke doc/DESIGN (first_time, not_needed)
** Invoke app/code.rb (first_time, not_needed)
** Execute doc/app/index.html
rm doc/app/fr_file_index.html doc/app/fr_class_index.html
doc/app/fr_method_index.html doc/app/index.html
doc/app/files/doc/README_FOR_APP.html
doc/app/files/doc/REQUIREMENTS.html doc/app/files/doc/DESIGN.html
doc/app/files/app/code_rb.html doc/app/classes/Code.html

                     README_FOR_APP:
                       REQUIREMENTS:
                             DESIGN:
                            code.rb: c
Generating HTML...

Files:   4
Classes: 1
Modules: 0
Methods: 0
Elapsed: 0.079s
** Execute gendocs
-------------------------------------------

It looks ok to me.  Are you getting something different?

--
-- Jim Weirich
This topic is locked and can not be replied to.