# Rdoc gem with hoe troubles

**URL:** <https://www.ruby-forum.com/t/rdoc-gem-with-hoe-troubles/81487>\
**Category:** Ruby\
**Created:** [January 9, 2007, 12:21pm UTC](https://www.ruby-forum.com/t/rdoc-gem-with-hoe-troubles/81487 "2007-01-09T12:21:08Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Paolo\_N](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/p/b9e5f3/32.png) [@Paolo\_N](https://www.ruby-forum.com/u/Paolo_N)\
**Post date:** [January 9, 2007, 12:21pm UTC](https://www.ruby-forum.com/t/rdoc-gem-with-hoe-troubles/81487/1 "2007-01-09T12:21:08Z")

</div>

Hi

I’m working on a new gem which is pretty much ready to be released.

I’m using hoe to manage it but I can’t get the rdoc task to include my  
README.txt as a doc index and the generated rdocs are not providing  
the [show source] link after every method.  
README.txt is included in the Manifest.txt

Could someone help me getting this working?

My relevant Rakefile lines

==rakefile start

AUTHOR = “blank” # can also be an array of Authors  
EMAIL = “your contact email for bug fixes and info”  
DESCRIPTION = “handles money objects using just integer as backend”  
GEM\_NAME = “more\_money” # what ppl will type to install your gem  
RUBYFORGE\_PROJECT = “moremoney” # The unix name for your project  
HOMEPATH = “http://#{RUBYFORGE\_PROJECT}.rubyforge.org”  
RELEASE\_TYPES = %w( gem ) # can use: gem, tar, zip

NAME = “more\_money”  
REV = nil # UNCOMMENT IF REQUIRED:  
File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil  
VERS = ENV[‘VERSION’] || (MoreMoney::VERSION::STRING + (REV ? “.#{REV}”  
: “”))  
CLEAN.include [’\*\*/._.sw?’, '_.gem’, ‘.config’]

hoe = Hoe.new(GEM\_NAME, VERS) do |p|  
p.author = AUTHOR  
p.description = DESCRIPTION  
p.email = EMAIL  
p.summary = DESCRIPTION  
p.url = HOMEPATH  
p.rubyforge\_name = RUBYFORGE\_PROJECT if RUBYFORGE\_PROJECT  
p.test\_globs = [“test/\*\*/\*\_test.rb”]  
p.clean\_globs = CLEAN #An array of file patterns to delete on clean.  
end

==rakefile end

Thanks

Paolo

---

<div class="post-metadata">

**Author:** ![Paolo\_N](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/p/b9e5f3/32.png) [@Paolo\_N](https://www.ruby-forum.com/u/Paolo_N)\
**Post date:** [January 10, 2007, 12:06am UTC](https://www.ruby-forum.com/t/rdoc-gem-with-hoe-troubles/81487/2 "2007-01-10T00:06:00Z")

</div>

Hi Eric

Thanks for your reply, with it I managed to fix all my issues.  
I still have to understand why now the gem\_server on my machine still  
shows the rdocs without readme file (even after a version number  
update and a complete cleanup), but the gem now generates all the docs  
as I expected.

Anyway my gem is finished and online and I’m quite happy with it.

P.S. I’ll try to make my Rakefile more clean 🙂

Thanks again

---

<div class="post-metadata">

**Author:** ![Paolo\_N](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/p/b9e5f3/32.png) [@Paolo\_N](https://www.ruby-forum.com/u/Paolo_N)\
**Post date:** [January 9, 2007, 5:53pm UTC](https://www.ruby-forum.com/t/rdoc-gem-with-hoe-troubles/81487/3 "2007-01-09T17:53:13Z")

</div>

On Jan 9, 2007, at 03:20, Paolo N. wrote:

> Hi
> 
> I’m working on a new gem which is pretty much ready to be released.
> 
> I’m using hoe to manage it but I can’t get the rdoc task to include my  
> README.txt as a doc index

show the output of rake docs and rake check\_manifest.

> and the generated rdocs are not providing the [show source] link  
> after every method.

Hoe uses the default RDoc template. Click the method name to see the  
source.

> README.txt is included in the Manifest.txt
> 
> Could someone help me getting this working?

PS: Quit making the Rakefile so complicated. This should be all you  
need:

hoe = Hoe.new ‘more\_money’, MoreMoney::VERSION::STRING do |p|  
p.summary = “handles money objects using just integer as backend”  
p.url = “[http://moremoney.rubyforge.org](http://moremoney.rubyforge.org)”  
p.rubyforge\_name = “moremoney”  
p.test\_globs = ["test/**/\*\_test.rb"]  
p.clean\_globs = ['**/._.sw?', '_.gem’, ‘.config’]  
end

–  
Eric H. - removed\_email\_address@domain.invalid - [http://blog.segment7.net](http://blog.segment7.net)

I LIT YOUR GEM ON FIRE!