# RDoc format

**URL:** <https://www.ruby-forum.com/t/rdoc-format/70085>\
**Category:** Ruby\
**Created:** [February 18, 2006, 3:48pm UTC](https://www.ruby-forum.com/t/rdoc-format/70085 "2006-02-18T15:48:55Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![brian](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/97f17d/32.png) [@brian](https://www.ruby-forum.com/u/brian)\
**Post date:** [February 18, 2006, 3:48pm UTC](https://www.ruby-forum.com/t/rdoc-format/70085/1 "2006-02-18T15:48:55Z")

</div>

Hello all,

One format of RDocs comes with a very useful [show source] link for  
each  
method. Example ([http://api.rubyonrails.com/](http://api.rubyonrails.com/) ). Another format of  
RDocs we  
often see does not provide those links. Here’s an example (  
[corevx.com](http://corevx.com/bioruby/doc/)) Far less useful.

How can one specify the RDoc format so that, for example, when one runs  
gem\_server the format of RDocs provided is the former?

Thanks.

Brian B.

---

<div class="post-metadata">

**Author:** ![brian](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/97f17d/32.png) [@brian](https://www.ruby-forum.com/u/brian)\
**Post date:** [February 18, 2006, 4:34pm UTC](https://www.ruby-forum.com/t/rdoc-format/70085/2 "2006-02-18T16:34:18Z")

</div>

DÅ?a Sobota 18 FebruÃ¡r 2006 15:45 Brian B. napÃ­sal:

> Thanks.
> 
> Brian B.

Passing the -S or --inline-source option to RDoc does that. It has to be  
done  
when the documentation is generated. The format is actually identical,  
just  
the HTML templates and CSS is different, I think.

David V.
