<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/css" href="/stylesheets/rss.css"?>
<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
  <channel>
    <title>Slash Dot Dash: Creating your own Rails API documentation</title>
    <link>http://www.slashdotdash.net/articles/2007/07/29/creating-your-own-rails-api-documentation</link>
    <language>en-us</language>
    <ttl>40</ttl>
    <description>Rolling on Rails</description>
    <item>
      <title>Creating your own Rails API documentation</title>
      <description>&lt;p&gt;The second edition of the &amp;#8220;Agile Web Development with Rails&amp;#8221; book has the following tip for creating the Rails &lt;span class="caps"&gt;API&lt;/span&gt; docs from the latest gem version on your machine (or you could get the edge version by using &lt;code&gt;rake rails:freeze:edge&lt;/code&gt;).&lt;/p&gt;


&lt;pre&gt;
$ rails dummy_app 
$ cd dummy_app 
$ rake rails:freeze:gems 
$ echo &amp;gt;vendor/rails/activesupport/README 
$ rake doc:rails 
&lt;/pre&gt;

	&lt;p&gt;After it completes simply copy the &lt;code&gt;api&lt;/code&gt; folder inside the &lt;code&gt;doc&lt;/code&gt; directory (and then you can delete the &lt;code&gt;dummy_app&lt;/code&gt;).&lt;/p&gt;


	&lt;p&gt;Another related tip for those who haven&amp;#8217;t yet discovered the site &lt;a href="http://www.gotapi.com/rubyrails"&gt;gotapi.com&lt;/a&gt; is a great reference with  find-as-you type api searching.&lt;/p&gt;</description>
      <pubDate>Sun, 29 Jul 2007 13:11:00 +0100</pubDate>
      <guid isPermaLink="false">urn:uuid:b1ce2aed-26e3-4bf8-b0c0-f252bd6d556a</guid>
      <author>ben@slashdotdash.net (Ben)</author>
      <link>http://www.slashdotdash.net/articles/2007/07/29/creating-your-own-rails-api-documentation</link>
      <category>Ruby on Rails</category>
    </item>
    <item>
      <title>"Creating your own Rails API documentation" by Martin</title>
      <description>&lt;p&gt;Another possibility for having the Rails API doc on your computer is simply to use the one that is already there. Since Rails is installed via a gem, you can youse the comand line program gem_server, that will start a Webrick on localhost:8808 with a reference to all RDocs for your locally installed gems, that include as well Rails.&lt;/p&gt;</description>
      <pubDate>Mon, 30 Jul 2007 06:38:36 +0100</pubDate>
      <guid isPermaLink="false">urn:uuid:0fa37c06-0fe1-41ee-94f7-d07b26cbbe61</guid>
      <link>http://www.slashdotdash.net/articles/2007/07/29/creating-your-own-rails-api-documentation#comment-117</link>
    </item>
  </channel>
</rss>
